All parameters except 'q' are optional.

Special Fields

Examples

https://localhost:5984/dbname/_fti?q=field_name:value
https://localhost:5984/dbname/_fti?q=field_name:value&sort;=other_field
https://localhost:5984/dbname/_fti?debug=true&sort;=billing_size&q;=body:document AND customer:[A TO C]
https://localhost:5984/dbname/_fti?debug=true&sort;=billing_size&q;=body:document AND customer:[100 TO 400]

Search Results Format

return values is a JSON array of id, rev and sort_field values (the latter only when sort= is supplied)

{
  "total_rows":49999,
  "rows":
  [
    {"_id":"9","_rev":"2779848574","score":1.712123155593872},
    {"_id":"8","_rev":"670155834","score":1.712123155593872}
  ]
}

{
  "total_rows":49999,
  "sort_order":
  [
    {"field":"customer","reverse":false,"type":"string"},
    {"reverse":false,"type":"doc"}
  ],
  "rows":
  [
    {"_id":"75000","_rev":"372496647","score":1.712123155593872,"sort_order":["00000000000000",50802]},
    {"_id":"170036","_rev":"3628205594","score":1.712123155593872,"sort_order":["00000000000000",51716]}
  ]
}

Working With The Source

To develop "live", type "mvn dependency:unpack-dependencies" and change the external line to something like this;

fti=/usr/bin/java -cp /path/to/couchdb-lucene/target/classes:\
/path/to/couchdb-lucene/target/dependency org.apache.couchdb.lucene.Main

You will need to restart CouchDB if you change couchdb-lucene source code but this is very fast.

Configuration

couchdb-lucene respects several system properties;

You can override these properties like this;

fti=/usr/bin/java -D couchdb.lucene.dir=/tmp \
-cp /home/rnewson/Source/couchdb-lucene/target/classes:\
/home/rnewson/Source/couchdb-lucene/target/dependency\
org.apache.couchdb.lucene.Main