Package Exports

lucene-query-generator

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (lucene-query-generator) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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

convert

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

Querying all fields

The simplest form of query

generator.convert({ $operands: [ 'hello world!' ] }
// 'hello world\!'

Querying fielded data

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

Defaults to the AND operator.

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

Specify the OR operator.

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

Create a disjunction on one field.

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

null values will be ignored.

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

Specify the NOT operator.

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

Nested queries

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

Field types

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.

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<long>:123456789 AND dob<date>:"1970-01-02T10:17:36.789Z" AND dod<date>:"2014-05-31T11:00:00.000Z"

Range queries

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

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

Development

npm install
npm test

Build Status

Builds brought to you courtesy of Travis CI.