lucene-query-generator

Builds a lucene query string from an object. Escapes the field names and values to prevent errors on user input. Can be used in the browser or node, however to avoid injection must be run server side.

Installation

``
npm install lucene-query-generator
`

API

$3

Convert an object into a string query.

#### Arguments

* terms: Object representing the query
* options (optional): Object with the following
* schema (optional): The field type mapping

Examples

$3

The simplest form of query

`js
generator.convert({ $operands: [ 'hello world' ] }
// 'hello world'
`

$3

Query specific fields using key value pairs to represent the field name and desired value respectively.

Defaults to the AND operator.

`js
generator.convert({
$operands: [{ name: 'gareth' }, { job: 'geek' }]
});
// 'name:gareth AND job:geek'
`

Specify the OR operator.

`js
generator.convert({
$operator: 'OR',
$operands: [{ name: 'gareth' }, { job: 'geek' }]
});
// 'name:gareth OR job:geek'
`

Create a disjunction on one field.

`js
generator.convert({
$operands: [{ name: ['gareth', 'milan'] }]
});
// 'name:(gareth OR milan)'
`

null values will be ignored.

`js
generator.convert({
$operands: [{ name: 'gareth' }, { job: null }]
});
// 'name:gareth'
`

Specify the NOT operator.

`js
generator.convert({
$operands: [
{ name: 'gareth' },
{
$operator: 'not',
$operands: [
{ job: 'geek' }
]
}
]
});
// name:gareth AND NOT job:geek
`

Unlike searching all fields, values will be escaped automatically.

`js
generator.convert({
$operands: [
{ name: 'gareth-bowen' }
]
});
// name:"gareth-bowen"
`

$3

`js
generator.convert({
$operator: 'and',
$operands: [
{ name: 'gareth' },
{
$operator: 'or',
$operands: [
{ job: 'geek' },
{ job: 'musician' }
]
}
]
});
// name:gareth AND (job:geek OR job:musician)
`

$3

All field terms default to type string, which can be overridden by providing a schema. Available types are: string, int, long, float, double, boolean, date. Dates can be either Date objects or ISO Strings.

`js
generator.convert(
{
$operands: [{
name: 'gareth',
seconds: 123456789,
dob: new Date(123456789),
dod: '2014-05-31T11:00:00.000Z'
}]
}, {
schema: {
seconds: 'long',
dob: 'date',
dod: 'date'
}
}
);
// name:gareth AND seconds:123456789 AND dob:"1970-01-02T10:17:36.789Z" AND dod:"2014-05-31T11:00:00.000Z"
`

Escaping can be turned off for field values if you want to allow your users to be able to provide lucene expressions.

`js
generator.convert(
{
$operands: [{
name: 'gar?th'
}]
}, {
schema: {
name: {
type: 'string',
allowSpecialCharacters: true
}
}
}
);
// name:gar?th
`

$3

Query for values matching a range with the $from and $to keys.

`js
generator.convert(
{
$operands: [{
name: { $from: 'gareth', $to: 'milan' },
age: { $from: 55, $to: 63 }
}]
}, {
schema: {
age: 'int'
}
}
);
// name:[gareth TO milan] AND age:[55 TO 63]
`

Development

`
npm install
npm test
``

Build Status

Builds brought to you courtesy of Travis CI.