Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 505 lines (402 sloc) 16.873 kb
b9ba5b0 Robert Newson warn against using 0.5 for now.
authored
1 <h1>WARNING</h1>
90790ae Robert Newson add recommendation for 0.4 for now.
authored
2
ef3d4be Robert Newson tentatively recommend 0.5 over 0.4
authored
3 0.5 is not yet released and may contain bugs and regressions. However, it is shaping up nicely so I recommend you try it first. 0.4 remains available if you hit insurmountable problems; but please take time to file a ticket at github if you do.
90790ae Robert Newson add recommendation for 0.4 for now.
authored
4
6d1c074 Robert Newson add notes about version compatibility.
authored
5 <h1>Version Compatibility</h1>
6
7 <table>
8 <tr><th>CouchDB</th><th>couchdb-lucene</th></tr>
9 <tr><td>0.9.1, 0.10</td><td>0.4</td></tr>
d90560d Robert Newson update docs.
authored
10 <tr><td>0.11 (not yet released)</td><td>0.4-maint (0.4 with patch for trunk compatibility)</td></tr>
fc8e42c Robert Newson add support for 0.10.x
authored
11 <tr><td>0.10+</td><td>0.5 (not yet released)</td></tr>
6d1c074 Robert Newson add notes about version compatibility.
authored
12 </table>
13
c6356fd Robert Newson update README.md and TODO to reflect progress.
authored
14 <h1>Issue Tracking</h1>
a785480 Robert Newson lighthouse sucks at formatting anything, abandon ship.
authored
15
7a0d1d3 Robert Newson lighthouse sucks at formatting anything, abandon ship.
authored
16 Issue tracking at <a href="http://github.com/rnewson/couchdb-lucene/issues">github</a>.
5d4e56a Robert Newson update readme.
authored
17
7dc5bac Robert Newson reorg begins.
authored
18 <h1>Minimum System Requirements</h1>
ef3f787 Robert Newson add sysreq for Sun JDK.
authored
19
796a42b Robert Newson jdk 5 compatibility for readme.
authored
20 Java 1.5 (or above) is required; the Sun version is recommended as it's regularly tested against.
ef3f787 Robert Newson add sysreq for Sun JDK.
authored
21
5220b65 Robert Newson tweak README.md
authored
22 <h1>Build couchdb-lucene</h1>
b207965 Robert Newson improve README readability.
authored
23
24 <ol>
25 <li>Install Maven 2.
26 <li>checkout repository
27 <li>type 'mvn'
28 <li>configure couchdb (see below)
29 </ol>
30
2d6180b Robert Newson include properties file in zip. still not available to run script, thoug...
authored
31 You will now have a zip file in the target/ directory. This contains all the couchdb-lucene code, dependencies, startup scripts and configuration files to run couchdb-lucene.
32
b207965 Robert Newson improve README readability.
authored
33 <h1>Configure CouchDB</h1>
34
35 <pre>
0563120 Robert Newson fixes.
authored
36 [couchdb]
37 os_process_timeout=60000 ; increase the timeout from 5 seconds.
38
b207965 Robert Newson improve README readability.
authored
39 [external]
cbfe065 Robert Newson remove registry and indexkey, change output paths
authored
40 fti=/path/to/python /usr/lib/couchdb/couchdb-lucene/couchdb-external-hook.py
b207965 Robert Newson improve README readability.
authored
41
42 [httpd_db_handlers]
43 _fti = {couch_httpd_external, handle_external_req, <<"fti">>}
44 </pre>
45
cbfe065 Robert Newson remove registry and indexkey, change output paths
authored
46 <h2>Hook options</h2>
47
48 <table>
49 <tr><th>Option</th><th>Meaning</th><th>Default Value</th></tr>
50 <tr><td>--remote-host</td><td>The hostname of the couchdb-lucene server</td><td>localhost</td></tr>
51 <tr><td>--remote-port</td><td>The port of the couchdb-lucene server</td><td>5985</td></tr>
52 <tr><td>--local-host</td><td>The hostname of the couchdb server</td><td>localhost</td></tr>
53 <tr><td>--local-port</td><td>The port of the couchdb server</td><td>5984</td></tr>
54 </table>
b047e4a Robert Newson update README.md to reflect (future) start/stop and config changes.
authored
55
cbfe065 Robert Newson remove registry and indexkey, change output paths
authored
56 <h1>Configure couchdb-lucene</h1>
b047e4a Robert Newson update README.md to reflect (future) start/stop and config changes.
authored
57
cbfe065 Robert Newson remove registry and indexkey, change output paths
authored
58 couchdb-lucene runs in a single, standalone JVM. As such, you can choose to locate your couchdb-lucene server on a different machine to couchdb if you wish, or keep it on the same machine, it's your call.
b047e4a Robert Newson update README.md to reflect (future) start/stop and config changes.
authored
59
60 <h1>Start couchdb-lucene</h1>
61
62 To start couchdb-lucene, run;
63 <pre>
2d6180b Robert Newson include properties file in zip. still not available to run script, thoug...
authored
64 bin/run
b047e4a Robert Newson update README.md to reflect (future) start/stop and config changes.
authored
65 </pre>
66
2d6180b Robert Newson include properties file in zip. still not available to run script, thoug...
authored
67 To stop couchdb-lucene, simply kill the Java process.
b047e4a Robert Newson update README.md to reflect (future) start/stop and config changes.
authored
68
b207965 Robert Newson improve README readability.
authored
69 <h1>Indexing Strategy</h1>
70
4a60080 Robert Newson use couchdb's content_type rather than auto-detect.
authored
71 <h2>Document Indexing</h2>
72
4c21806 Robert Newson mention that you can return Document[] from an index function.
authored
73 You must supply a index function in order to enable couchdb-lucene as, by default, nothing will be indexed. To suppress a document from the index, return null. It's more typical to return a single Document object which contains everything you'd like to query and retrieve. You may also return an array of Document objects if you wish.
a2e9024 Robert Newson wip
authored
74
437eae9 Robert Newson s/view/fulltext in README.md
authored
75 You may add any number of index views in any number of design documents. All searches will be constrained to documents emitted by the index functions.
c207a60 Robert Newson update README
authored
76
5077366 Robert Newson clarify design document and add matching query URL's.
authored
77 Here's an complete example of a design document with couchdb-lucene features:
a2e9024 Robert Newson wip
authored
78
697884b Robert Newson documentation of future features.
authored
79 <pre>
80 {
d1c9c80 Robert Newson correct _id of first example.
authored
81 "_id":"_design/a_design_document_with_any_name_you_like",
5077366 Robert Newson clarify design document and add matching query URL's.
authored
82 "fulltext": {
83 "by_subject": {
84 "index":"function(doc) { var ret=new Document(); ret.add(doc.subject); return ret }"
85 },
86 "by_content": {
87 "index":"function(doc) { var ret=new Document(); ret.add(doc.content); return ret }"
88 }
697884b Robert Newson documentation of future features.
authored
89 }
90 }
91 </pre>
92
5077366 Robert Newson clarify design document and add matching query URL's.
authored
93 Here are some example URL's for the given design document;
94
95 <pre>
96 http://localhost:5984/database/_fti/lucene/by_subject?q=hello
97 http://localhost:5984/database/_fti/lucene/by_content?q=hello
98 </pre>
99
697884b Robert Newson documentation of future features.
authored
100 A fulltext object contains multiple index view declarations. An index view consists of;
101
102 <dl>
f420bf7 Robert Newson support different Analyzer's at index and query time.
authored
103 <dt>analyzer</dt><dd>(optional) The analyzer to use</dd>
104 <dt>defaults</dt><dd>(optional) The default for numerous indexing options can be overridden here. A full list of options follows.</dd>
697884b Robert Newson documentation of future features.
authored
105 <dt>index</dt><dd>The indexing function itself, documented below.</dd>
f420bf7 Robert Newson support different Analyzer's at index and query time.
authored
106 </dl>
697884b Robert Newson documentation of future features.
authored
107
108 <h3>The Defaults Object</h3>
109
110 The following indexing options can be defaulted;
111
112 <table>
113 <tr>
114 <th>name</th>
115 <th>description</th>
116 <th>available options</th>
117 <th>default</th>
118 </tr>
119 <tr>
a40523d Robert Newson documentation of future features.
authored
120 <th>field</th>
121 <td>the field name to index under</td>
122 <td>user-defined</td>
123 <td>default</td>
d2e1e9e Robert Newson add notes about typing.
authored
124 </tr>
125 <tr>
126 <th>type</th>
127 <td>the type of the field</td>
128 <td>date, double, float, integer, long, string</td>
129 <td>string</td>
130 </tr>
a40523d Robert Newson documentation of future features.
authored
131 <tr>
697884b Robert Newson documentation of future features.
authored
132 <th>store</th>
f16fc9c Robert Newson docs
authored
133 <td>whether the data is stored. The value will be returned in the search result.</td>
697884b Robert Newson documentation of future features.
authored
134 <td>yes, no</td>
135 <td>no</td>
d2e1e9e Robert Newson add notes about typing.
authored
136 </tr>
697884b Robert Newson documentation of future features.
authored
137 <tr>
138 <th>index</th>
139 <td>whether (and how) the data is indexed</td>
8328332 Robert Newson typo
authored
140 <td>analyzed, analyzed_no_norms, no, not_analyzed, not_analyzed_no_norms</td>
697884b Robert Newson documentation of future features.
authored
141 <td>analyzed</td>
d2e1e9e Robert Newson add notes about typing.
authored
142 </tr>
697884b Robert Newson documentation of future features.
authored
143 </table>
087dcec Robert Newson update documentation.
authored
144
f420bf7 Robert Newson support different Analyzer's at index and query time.
authored
145 <h3>The Analyzer Option</h3>
146
147 Lucene has numerous ways of converting free-form text into tokens, these classes are called Analyzer's. By default, the StandardAnalyzer is used which lower-cases all text, drops common English words ("the", "and", and so on), among other things. This processing might not always suit you, so you can choose from several others by setting the "analyzer" field to one of the following values;
148
149 <ul>
150 <li>brazilian</li>
151 <li>chinese</li>
152 <li>cjk</li>
153 <li>czech</li>
154 <li>dutch</li>
155 <li>english</li>
156 <li>french</li>
157 <li>german</li>
158 <li>keyword</li>
159 <li>porter</li>
160 <li>russian</li>
161 <li>simple</li>
162 <li>standard</li>
163 <li>thai</li>
164 </ul>
165
166 Note: You must also supply analyzer=<analyzer_name> as a query parameter to ensure that queries are processed correctly.
167
087dcec Robert Newson update documentation.
authored
168 <h3>The Document class</h3>
169
170 You may construct a new Document instance with;
171
172 <pre>
173 var doc = new Document();
174 </pre>
175
a40523d Robert Newson documentation of future features.
authored
176 Data may be added to this document with the add method which takes an optional second object argument that can override any of the above default values.
087dcec Robert Newson update documentation.
authored
177
178 <pre>
a40523d Robert Newson documentation of future features.
authored
179 // Add with all the defaults.
180 doc.add("value");
181
d2e1e9e Robert Newson add notes about typing.
authored
182 // Add a numeric field.
183 doc.add(35, {"type":"integer"});
184
4670582 Robert Newson use NumericField. currently broken.
authored
185 // Add a date field.
186 doc.add(new Date("2009-01-01"), {"type":"date"});
187
d2e1e9e Robert Newson add notes about typing.
authored
188 // Add a date field (object must be a Date object
189
a40523d Robert Newson documentation of future features.
authored
190 // Add a subject field.
191 doc.add("this is the subject line.", {"field":"subject"});
9a71557 Robert Newson formatting
authored
192
a40523d Robert Newson documentation of future features.
authored
193 // Add but ensure it's stored.
194 doc.add("value", {"store":"yes"});
9a71557 Robert Newson formatting
authored
195
a40523d Robert Newson documentation of future features.
authored
196 // Add but don't analyze.
197 doc.add("don't analyze me", {"index":"not_analyzed"});
9a71557 Robert Newson formatting
authored
198
199 // Extract text from the named attachment and index it (but not store it).
a40523d Robert Newson documentation of future features.
authored
200 doc.attachment("attachment name", {"field":"attachments"});
087dcec Robert Newson update documentation.
authored
201 </pre>
202
ccb81a8 Robert Newson add example transforms section.
authored
203 <h3>Example Transforms</h3>
204
390858a Robert Newson re-add Index Everything example.
authored
205 <h4>Index Everything</h4>
206
207 <pre>
208 function(doc) {
7bad7dc Robert Newson correct syntax error in JS fun.
authored
209 var ret = new Document();
210
211 function idx(obj) {
212 for (var key in obj) {
213 switch (typeof obj[key]) {
214 case 'object':
215 idx(obj[key]);
216 break;
217 case 'function':
218 break;
219 default:
220 ret.add(obj[key]);
221 break;
222 }
223 }
224 };
225
226 idx(doc);
227
228 if (doc._attachments) {
229 for (var i in doc._attachments) {
230 ret.attachment("attachment", i);
231 }
390858a Robert Newson re-add Index Everything example.
authored
232 }
d2e1e9e Robert Newson add notes about typing.
authored
233
7bad7dc Robert Newson correct syntax error in JS fun.
authored
234 return ret;
390858a Robert Newson re-add Index Everything example.
authored
235 }
236 </pre>
237
ccb81a8 Robert Newson add example transforms section.
authored
238 <h4>Index Nothing</h4>
239
240 <pre>
241 function(doc) {
242 return null;
243 }
244 </pre>
245
c207a60 Robert Newson update README
authored
246 <h4>Index Select Fields</h4>
ccb81a8 Robert Newson add example transforms section.
authored
247
248 <pre>
249 function(doc) {
c207a60 Robert Newson update README
authored
250 var result = new Document();
c6356fd Robert Newson update README.md and TODO to reflect progress.
authored
251 result.add(doc.subject, {"field":"subject", "store":"yes"});
252 result.add(doc.content, {"field":"subject"});
5cfa20c Robert Newson fix error in example
authored
253 result.add(new Date(), {"field":"indexed_at"});
c207a60 Robert Newson update README
authored
254 return result;
ccb81a8 Robert Newson add example transforms section.
authored
255 }
256 </pre>
257
c207a60 Robert Newson update README
authored
258 <h4>Index Attachments</h4>
ccb81a8 Robert Newson add example transforms section.
authored
259
260 <pre>
261 function(doc) {
c207a60 Robert Newson update README
authored
262 var result = new Document();
263 for(var a in doc._attachments) {
244df30 Robert Newson fix mistake in README
authored
264 result.attachment(a, {"field":"attachment"});
ccb81a8 Robert Newson add example transforms section.
authored
265 }
c207a60 Robert Newson update README
authored
266 return result;
267 }
268 </pre>
269
270 <h4>A More Complex Example</h4>
271
272 <pre>
273 function(doc) {
274 var mk = function(name, value, group) {
c6356fd Robert Newson update README.md and TODO to reflect progress.
authored
275 var ret = new Document();
2946c9a Robert Newson fix example.
authored
276 ret.add(value, {"field": group, "store":"yes"});
c6356fd Robert Newson update README.md and TODO to reflect progress.
authored
277 ret.add(group, {"field":"group", "store":"yes"});
c207a60 Robert Newson update README
authored
278 return ret;
279 };
280 if(doc.type != "reference") return null;
a313b24 Robert Newson lots of stuff.
authored
281 var ret = new Array();
c207a60 Robert Newson update README
authored
282 for(var g in doc.groups) {
a313b24 Robert Newson lots of stuff.
authored
283 ret.push(mk("library", doc.groups[g].library, g));
284 ret.push(mk("method", doc.groups[g].method, g));
285 ret.push(mk("target", doc.groups[g].target, g));
c207a60 Robert Newson update README
authored
286 }
287 return ret;
288 }
289 </pre>
b207965 Robert Newson improve README readability.
authored
290
4a60080 Robert Newson use couchdb's content_type rather than auto-detect.
authored
291 <h2>Attachment Indexing</h2>
292
8059ce0 Robert Newson s/couchdb/couchdb-lucene
authored
293 Couchdb-lucene uses <a href="http://lucene.apache.org/tika/">Apache Tika</a> to index attachments of the following types, assuming the correct content_type is set in couchdb;
4a60080 Robert Newson use couchdb's content_type rather than auto-detect.
authored
294
ec94e21 Robert Newson updated README.md
authored
295 <h3>Supported Formats</h3>
296
4a60080 Robert Newson use couchdb's content_type rather than auto-detect.
authored
297 <ul>
298 <li>Excel spreadsheets (application/vnd.ms-excel)
299 <li>HTML (text/html)
300 <li>Images (image/*)
301 <li>Java class files
302 <li>Java jar archives
303 <li>MP3 (audio/mp3)
304 <li>OpenDocument (application/vnd.oasis.opendocument.*)
f420bf7 Robert Newson support different Analyzer's at index and query time.
authored
305 <li>Outlook (application/vnd.ms-outlook)
4a60080 Robert Newson use couchdb's content_type rather than auto-detect.
authored
306 <li>PDF (application/pdf)
f420bf7 Robert Newson support different Analyzer's at index and query time.
authored
307 <li>Plain text (text/plain)
308 <li>Powerpoint presentations (application/vnd.ms-powerpoint)
4a60080 Robert Newson use couchdb's content_type rather than auto-detect.
authored
309 <li>RTF (application/rtf)
f420bf7 Robert Newson support different Analyzer's at index and query time.
authored
310 <li>Visio (application/vnd.visio)
311 <li>Word documents (application/msword)
312 <li>XML (application/xml)
4a60080 Robert Newson use couchdb's content_type rather than auto-detect.
authored
313 </ul>
314
b207965 Robert Newson improve README readability.
authored
315 <h1>Searching with couchdb-lucene</h1>
316
2b14b76 Robert Newson describ syntax for all forms of numeric range query
authored
317 You can perform all types of queries using Lucene's default <a href="http://lucene.apache.org/java/2_4_0/queryparsersyntax.html">query syntax</a>.
318
319 <h2>Numeric range queries</h2>
320
321 In addition to normal text-based range searches (using the "field:[lower TO upper]" syntax), couchdb-lucene all supports numeric range searches for the following types: integer, long, float, double and date. The type is automatically derived from the search terms used, as follows;
322
323 <table>
324 <tr><td>type</td><td>format</td><td>example</td></tr>
325 <tr><td>integer</td><td>[0-9]+</td><td>[0 TO 100]</td></tr>
326 <tr><td>long</td><td>[0-9]+L</td><td>[0L TO 100L]</td></tr>
327 <tr><td>float</td><td>[0-9]+.[0-9]+f</td><td>[0.0f TO 100.0f]</td></tr>
328 <tr><td>double</td><td>[0-9]+.[0-9]+</td><td>[0.0 TO 100.0]</td></tr>
329 <tr><td>date</td><td>yyyy-MM-dd or yyyy-MM-ddZZ or yyyy-MM-dd'T'HH:mm:ss or yyyy-MM-dd'T'HH:mm:ssZZ</td><td>2001-01-01 or 2001-01-01-0500 or 2000-01-01T00:00:00 or 2000-01-01T00:00:00-0500</td></tr>
330 </table>
331
332 Both the upper and lower bound must be of the same type to trigger numeric range searching. If they don't match, then a normal text-based range search is performed.
333
334 The following parameters can be passed for more sophisticated searches;
b207965 Robert Newson improve README readability.
authored
335
336 <dl>
f420bf7 Robert Newson support different Analyzer's at index and query time.
authored
337 <dt>analyzer</dt><dd>The analyzer used to convert the query string into a query object.
338 <dt>callback</dt><dd>Specify a JSONP callback wrapper. The full JSON result will be prepended with this parameter and also placed with parentheses."
71cbc0b Robert Newson correct description of debug setting.
authored
339 <dt>debug</dt><dd>Setting this to true disables response caching (the query is executed every time) and indents the JSON response for readability.</dd>
ea19e55 Robert Newson add force_json=true to force 'application/json' response type.
authored
340 <dt>force_json<dt><dd>Usually couchdb-lucene determines the Content-Type of its response based on the presence of the Accept header. If Accept contains "application/json", you get "application/json" in the response, otherwise you get "text/plain;charset=utf8". Some tools, like JSONView for FireFox, do not send the Accept header but do render "application/json" responses if received. Setting force_json=true forces all response to "application/json" regardless of the Accept header.</dd>
f420bf7 Robert Newson support different Analyzer's at index and query time.
authored
341 <dt>include_docs</dt><dd>whether to include the source docs</dd>
f9c61e3 Robert Newson format README
authored
342 <dt>limit</dt><dd>the maximum number of results to return</dd>
f420bf7 Robert Newson support different Analyzer's at index and query time.
authored
343 <dt>q</dt><dd>the query to run (e.g, subject:hello). If not specified, the default field is searched.</dd>
f9c61e3 Robert Newson format README
authored
344 <dt>skip</dt><dd>the number of results to skip</dd>
fa0e48f Robert Newson add docs for numeric sorting too.
authored
345 <dt>sort</dt><dd>the comma-separated fields to sort on. Prefix with / for ascending order and \ for descending order (ascending is the default if not specified). Type-specific sorting is also available by appending a : and the sort type as normal (e.g, 'sort=amount:float'). Supported types are 'float', 'double', 'int', 'long' and 'date'.</dd>
637279a Robert Newson fix grammar in readme.
authored
346 <dt>stale=ok</dt><dd>If you set the <i>stale</i> option to <i>ok</i>, couchdb-lucene may not perform any refreshing on the index. Searches may be faster as Lucene caches important data (especially for sorting). A query without stale=ok will use the latest data committed to the index.</dd>
ad9096f Robert Newson tweak README.md
authored
347 </dl>
b207965 Robert Newson improve README readability.
authored
348
349 <i>All parameters except 'q' are optional.</i>
350
ec94e21 Robert Newson updated README.md
authored
351 <h2>Special Fields</h2>
352
353 <dl>
f9c61e3 Robert Newson format README
authored
354 <dt>_db</dt><dd>The source database of the document.</dd>
087dcec Robert Newson update documentation.
authored
355 <dt>_id</dt><dd>The _id of the document.</dd>
46a3a37 Robert Newson include all DC attributes, if present.
authored
356 </dl>
357
358 <h2>Dublin Core</h2>
359
360 All Dublin Core attributes are indexed and stored if detected in the attachment. Descriptions of the fields come from the Tika javadocs.
361
362 <dl>
6e99faa Robert Newson dc. to _dc.
authored
363 <dt>_dc.contributor</dt><dd> An entity responsible for making contributions to the content of the resource.</dd>
364 <dt>_dc.coverage</dt><dd>The extent or scope of the content of the resource.</dd>
365 <dt>_dc.creator</dt><dd>An entity primarily responsible for making the content of the resource.</dd>
366 <dt>_dc.date</dt><dd>A date associated with an event in the life cycle of the resource.</dd>
367 <dt>_dc.description</dt><dd>An account of the content of the resource.</dd>
368 <dt>_dc.format</dt><dd>Typically, Format may include the media-type or dimensions of the resource.</dd>
369 <dt>_dc.identifier</dt><dd>Recommended best practice is to identify the resource by means of a string or number conforming to a formal identification system.</dd>
370 <dt>_dc.language</dt><dd>A language of the intellectual content of the resource.</dd>
371 <dt>_dc.modified</dt><dd>Date on which the resource was changed.</dd>
372 <dt>_dc.publisher</dt><dd>An entity responsible for making the resource available.</dd>
373 <dt>_dc.relation</dt><dd>A reference to a related resource.</dd>
374 <dt>_dc.rights</dt><dd>Information about rights held in and over the resource.</dd>
375 <dt>_dc.source</dt><dd>A reference to a resource from which the present resource is derived.</dd>
376 <dt>_dc.subject</dt><dd>The topic of the content of the resource.</dd>
377 <dt>_dc.title</dt><dd>A name given to the resource.</dd>
378 <dt>_dc.type</dt><dd>The nature or genre of the content of the resource.</dd>
ec94e21 Robert Newson updated README.md
authored
379 </dl>
380
b207965 Robert Newson improve README readability.
authored
381 <h2>Examples</h2>
382
383 <pre>
405e3a3 Robert Newson update query urls' to reflect new syntax
authored
384 http://localhost:5984/dbname/_fti/design_doc/view_name?q=field_name:value
385 http://localhost:5984/dbname/_fti/design_doc/view_name?q=field_name:value&sort=other_field
386 http://localhost:5984/dbname/_fti/design_doc/view_name?debug=true&sort=billing_size&q=body:document AND customer:[A TO C]
b207965 Robert Newson improve README readability.
authored
387 </pre>
388
389 <h2>Search Results Format</h2>
390
0fcf578 Robert Newson update docs.
authored
391 The search result contains a number of fields at the top level, in addition to your search results.
392
393 <dl>
394 <dt>etag</dt><dd>An opaque token that reflects the current version of the index. This value is also returned in an ETag header to facilitate HTTP caching.</dd>
395 <dt>fetch_duration</dt><dd>The number of milliseconds spent retrieving the documents.</dd>
f420bf7 Robert Newson support different Analyzer's at index and query time.
authored
396 <dt>limit</dt><dd>The maximum number of results that can appear.</dd>
397 <dt>q</dt><dd>The query that was executed.</dd>
24591d9 Robert Newson docs
authored
398 <dt>rows</dt><dd>The search results array, described below.</dd>
f420bf7 Robert Newson support different Analyzer's at index and query time.
authored
399 <dt>search_duration</dt><dd>The number of milliseconds spent performing the search.</dd>
400 <dt>skip</dt><dd>The number of initial matches that was skipped.</dd>
401 <dt>total_rows</dt><dd>The total number of matches for this query.</dd>
0fcf578 Robert Newson update docs.
authored
402 </dl>
403
24591d9 Robert Newson docs
authored
404 <h2>The search results array</h2>
405
406 The search results arrays consists of zero, one or more objects with the following fields;
0fcf578 Robert Newson update docs.
authored
407
408 <dl>
f420bf7 Robert Newson support different Analyzer's at index and query time.
authored
409 <dt>doc</dt><dd>The original document from couch, if requested with include_docs=true</dd>
410 <dt>fields</dt><dd>All the fields that were stored with this match</dd>
0fcf578 Robert Newson update docs.
authored
411 <dt>id</dt><dd>The unique identifier for this match.</dd>
412 <dt>score</dt><dd>The normalized score (0.0-1.0, inclusive) for this match</dd>
413 </dl>
414
fd16315 Robert Newson update README.md
authored
415 Here's an example of a JSON response without sorting;
b207965 Robert Newson improve README readability.
authored
416
118d28e Robert Newson JSON example output.
authored
417 <pre>
418 {
c6356fd Robert Newson update README.md and TODO to reflect progress.
authored
419 "q": "+content:enron",
fd16315 Robert Newson update README.md
authored
420 "skip": 0,
421 "limit": 2,
422 "total_rows": 176852,
423 "search_duration": 518,
424 "fetch_duration": 4,
425 "rows": [
426 {
0fcf578 Robert Newson update docs.
authored
427 "id": "hain-m-all_documents-257.",
fd16315 Robert Newson update README.md
authored
428 "score": 1.601625680923462
429 },
430 {
0fcf578 Robert Newson update docs.
authored
431 "id": "hain-m-notes_inbox-257.",
fd16315 Robert Newson update README.md
authored
432 "score": 1.601625680923462
433 }
118d28e Robert Newson JSON example output.
authored
434 ]
435 }
436 </pre>
437
fd16315 Robert Newson update README.md
authored
438 And the same with sorting;
439
118d28e Robert Newson JSON example output.
authored
440 <pre>
441 {
0fcf578 Robert Newson update docs.
authored
442 "q": "+content:enron",
fd16315 Robert Newson update README.md
authored
443 "skip": 0,
444 "limit": 3,
445 "total_rows": 176852,
446 "search_duration": 660,
447 "fetch_duration": 4,
448 "sort_order": [
449 {
450 "field": "source",
451 "reverse": false,
452 "type": "string"
453 },
454 {
455 "reverse": false,
456 "type": "doc"
457 }
118d28e Robert Newson JSON example output.
authored
458 ],
fd16315 Robert Newson update README.md
authored
459 "rows": [
460 {
0fcf578 Robert Newson update docs.
authored
461 "id": "shankman-j-inbox-105.",
fd16315 Robert Newson update README.md
authored
462 "score": 0.6131107211112976,
463 "sort_order": [
464 "enron",
465 6
466 ]
467 },
468 {
0fcf578 Robert Newson update docs.
authored
469 "id": "shankman-j-inbox-8.",
fd16315 Robert Newson update README.md
authored
470 "score": 0.7492915391921997,
471 "sort_order": [
472 "enron",
473 7
474 ]
475 },
476 {
0fcf578 Robert Newson update docs.
authored
477 "id": "shankman-j-inbox-30.",
fd16315 Robert Newson update README.md
authored
478 "score": 0.507369875907898,
479 "sort_order": [
480 "enron",
481 8
482 ]
483 }
118d28e Robert Newson JSON example output.
authored
484 ]
485 }
486 </pre>
487
a4aa4e1 Robert Newson document Content-Type response negotiation
authored
488 <h3>Content-Type of response</h3>
489
d2e1e9e Robert Newson add notes about typing.
authored
490 The Content-Type of the response is negotiated via the Accept request header like CouchDB itself. If the Accept header includes "application/json" then that is also the Content-Type of the response. If not, "text/plain;charset=utf-8" is used.
a4aa4e1 Robert Newson document Content-Type response negotiation
authored
491
139a78c Robert Newson add info retrieval.
authored
492 <h1>Fetching information about the index</h1>
493
7a12058 Robert Newson docs
authored
494 Calling couchdb-lucene without arguments returns a JSON object with information about the <i>whole</i> index.
139a78c Robert Newson add info retrieval.
authored
495
496 <pre>
497 http://127.0.0.1:5984/enron/_fti
498 </pre>
499
500 returns;
501
502 <pre>
503 {"doc_count":517350,"doc_del_count":1,"disk_size":318543045}
504 </pre>
Something went wrong with that request. Please try again.