Skip to content
This repository
Newer
Older
100644 562 lines (446 sloc) 18.222 kb
6d1c0742 »
2009-09-15 add notes about version compatibility.
1 <h1>Version Compatibility</h1>
2
3 <table>
4 <tr><th>CouchDB</th><th>couchdb-lucene</th></tr>
5 <tr><td>0.9.1, 0.10</td><td>0.4</td></tr>
5cd5577a »
2010-04-12 0.11 is now released.
6 <tr><td>0.11</td><td>0.4-maint (0.4 with patch for trunk compatibility)</td></tr>
79285e8e »
2010-04-17 remove warning about 0.5 now it's out.
7 <tr><td>0.10.x and 0.11.x</td><td>0.5.x</td></tr>
6d1c0742 »
2009-09-15 add notes about version compatibility.
8 </table>
9
90845403 »
2010-04-17 add breaking changes section.
10 <h1>Breaking Changes</h1>
11
12 <ul>
79285e8e »
2010-04-17 remove warning about 0.5 now it's out.
13 <li>couchdb-lucene 0.5.x runs as a standalone daemon (0.4 was run directly by couchdb).
90845403 »
2010-04-17 add breaking changes section.
14 <li>URL's now require the full design document id (where you would say "foo", you must now say "_design/foo").
15 </ul>
16
c6356fd5 »
2009-04-26 update README.md and TODO to reflect progress.
17 <h1>Issue Tracking</h1>
a785480d »
2009-05-09 lighthouse sucks at formatting anything, abandon ship.
18
7a0d1d38 »
2009-05-09 lighthouse sucks at formatting anything, abandon ship.
19 Issue tracking at <a href="http://github.com/rnewson/couchdb-lucene/issues">github</a>.
5d4e56ad »
2009-03-06 update readme.
20
7dc5bac3 »
2009-09-02 reorg begins.
21 <h1>Minimum System Requirements</h1>
ef3f787b »
2009-04-06 add sysreq for Sun JDK.
22
796a42b6 »
2009-10-08 jdk 5 compatibility for readme.
23 Java 1.5 (or above) is required; the Sun version is recommended as it's regularly tested against.
ef3f787b »
2009-04-06 add sysreq for Sun JDK.
24
5220b654 »
2009-02-14 tweak README.md
25 <h1>Build couchdb-lucene</h1>
b2079657 »
2009-02-14 improve README readability.
26
27 <ol>
28 <li>Install Maven 2.
29 <li>checkout repository
30 <li>type 'mvn'
31 <li>configure couchdb (see below)
32 </ol>
33
2d6180b9 »
2009-10-07 include properties file in zip. still not available to run script, th…
34 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.
35
b2079657 »
2009-02-14 improve README readability.
36 <h1>Configure CouchDB</h1>
37
38 <pre>
05631204 »
2009-03-07 fixes.
39 [couchdb]
40 os_process_timeout=60000 ; increase the timeout from 5 seconds.
41
b2079657 »
2009-02-14 improve README readability.
42 [external]
5675f7a4 »
2010-01-07 fix path
43 fti=/path/to/python /path/to/couchdb-lucene/tools/couchdb-external-hook.py
b2079657 »
2009-02-14 improve README readability.
44
45 [httpd_db_handlers]
46 _fti = {couch_httpd_external, handle_external_req, <<"fti">>}
47 </pre>
48
cbfe0656 »
2009-11-24 remove registry and indexkey, change output paths
49 <h2>Hook options</h2>
50
51 <table>
52 <tr><th>Option</th><th>Meaning</th><th>Default Value</th></tr>
53 <tr><td>--remote-host</td><td>The hostname of the couchdb-lucene server</td><td>localhost</td></tr>
54 <tr><td>--remote-port</td><td>The port of the couchdb-lucene server</td><td>5985</td></tr>
c47c4947 »
2010-01-25 updated README to reflect latest Python scripts settings
55 <tr><td>--local-key</td><td>The key for the local couchdb instance as known to the couchdb-lucene server</td><td>local</td></tr>
cbfe0656 »
2009-11-24 remove registry and indexkey, change output paths
56 </table>
b047e4a2 »
2009-09-07 update README.md to reflect (future) start/stop and config changes.
57
cbfe0656 »
2009-11-24 remove registry and indexkey, change output paths
58 <h1>Configure couchdb-lucene</h1>
b047e4a2 »
2009-09-07 update README.md to reflect (future) start/stop and config changes.
59
cbfe0656 »
2009-11-24 remove registry and indexkey, change output paths
60 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.
b047e4a2 »
2009-09-07 update README.md to reflect (future) start/stop and config changes.
61
62 <h1>Start couchdb-lucene</h1>
63
64 To start couchdb-lucene, run;
65 <pre>
2d6180b9 »
2009-10-07 include properties file in zip. still not available to run script, th…
66 bin/run
b047e4a2 »
2009-09-07 update README.md to reflect (future) start/stop and config changes.
67 </pre>
68
2d6180b9 »
2009-10-07 include properties file in zip. still not available to run script, th…
69 To stop couchdb-lucene, simply kill the Java process.
b047e4a2 »
2009-09-07 update README.md to reflect (future) start/stop and config changes.
70
b2079657 »
2009-02-14 improve README readability.
71 <h1>Indexing Strategy</h1>
72
4a600804 »
2009-02-18 use couchdb's content_type rather than auto-detect.
73 <h2>Document Indexing</h2>
74
4c21806e »
2009-07-15 mention that you can return Document[] from an index function.
75 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.
a2e9024b »
2009-03-06 wip
76
437eae90 »
2009-05-03 s/view/fulltext in README.md
77 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.
c207a604 »
2009-04-04 update README
78
50773667 »
2009-07-09 clarify design document and add matching query URL's.
79 Here's an complete example of a design document with couchdb-lucene features:
a2e9024b »
2009-03-06 wip
80
697884bd »
2009-04-21 documentation of future features.
81 <pre>
82 {
3d2fb724 »
2010-04-17 fix example in README.
83 "_id":"_design/foo",
50773667 »
2009-07-09 clarify design document and add matching query URL's.
84 "fulltext": {
85 "by_subject": {
86 "index":"function(doc) { var ret=new Document(); ret.add(doc.subject); return ret }"
87 },
88 "by_content": {
89 "index":"function(doc) { var ret=new Document(); ret.add(doc.content); return ret }"
90 }
697884bd »
2009-04-21 documentation of future features.
91 }
92 }
93 </pre>
94
50773667 »
2009-07-09 clarify design document and add matching query URL's.
95 Here are some example URL's for the given design document;
96
97 <pre>
6b73dc6c »
2010-04-17 commit to _design/foo in paths, use regexp to be sure.
98 http://localhost:5984/database/_fti/_design/foo/by_subject?q=hello
99 http://localhost:5984/database/_fti/_design/foo/by_content?q=hello
50773667 »
2009-07-09 clarify design document and add matching query URL's.
100 </pre>
101
697884bd »
2009-04-21 documentation of future features.
102 A fulltext object contains multiple index view declarations. An index view consists of;
103
104 <dl>
f420bf7b »
2009-08-02 support different Analyzer's at index and query time.
105 <dt>analyzer</dt><dd>(optional) The analyzer to use</dd>
106 <dt>defaults</dt><dd>(optional) The default for numerous indexing options can be overridden here. A full list of options follows.</dd>
697884bd »
2009-04-21 documentation of future features.
107 <dt>index</dt><dd>The indexing function itself, documented below.</dd>
f420bf7b »
2009-08-02 support different Analyzer's at index and query time.
108 </dl>
697884bd »
2009-04-21 documentation of future features.
109
110 <h3>The Defaults Object</h3>
111
112 The following indexing options can be defaulted;
113
114 <table>
115 <tr>
116 <th>name</th>
117 <th>description</th>
118 <th>available options</th>
119 <th>default</th>
120 </tr>
121 <tr>
a40523d3 »
2009-04-21 documentation of future features.
122 <th>field</th>
123 <td>the field name to index under</td>
124 <td>user-defined</td>
125 <td>default</td>
d2e1e9ea »
2009-08-31 add notes about typing.
126 </tr>
127 <tr>
128 <th>type</th>
129 <td>the type of the field</td>
38ef3208 »
2010-02-19 fix documentation s/integer/int
130 <td>date, double, float, int, long, string</td>
d2e1e9ea »
2009-08-31 add notes about typing.
131 <td>string</td>
132 </tr>
a40523d3 »
2009-04-21 documentation of future features.
133 <tr>
697884bd »
2009-04-21 documentation of future features.
134 <th>store</th>
f16fc9c8 »
2009-04-26 docs
135 <td>whether the data is stored. The value will be returned in the search result.</td>
697884bd »
2009-04-21 documentation of future features.
136 <td>yes, no</td>
137 <td>no</td>
d2e1e9ea »
2009-08-31 add notes about typing.
138 </tr>
697884bd »
2009-04-21 documentation of future features.
139 <tr>
140 <th>index</th>
141 <td>whether (and how) the data is indexed</td>
83283325 »
2009-04-21 typo
142 <td>analyzed, analyzed_no_norms, no, not_analyzed, not_analyzed_no_norms</td>
697884bd »
2009-04-21 documentation of future features.
143 <td>analyzed</td>
d2e1e9ea »
2009-08-31 add notes about typing.
144 </tr>
f6bfce8f »
2010-05-03 add EXPERIMENTAL index-time field boosting feature.
145 <tr>
b00fb7f7 »
2010-05-06 add termvector to the possible options for Field.
146 <th>termvector</th>
147 <td>whether and how a field should have term vectors</td>
148 <td>no, with_offsets, with_positions, with_positions_offsets, yes</td>
149 <td>no</td>
150 </tr>
151 <tr>
f6bfce8f »
2010-05-03 add EXPERIMENTAL index-time field boosting feature.
152 <th>boost</th>
153 <td>Sets the boost factor hits on this field. This value will be multiplied into the score of all hits on this this field of this document.</td>
154 <td>floating-point value</td>
155 <td>1.0</td>
156 </tr>
697884bd »
2009-04-21 documentation of future features.
157 </table>
087dcec0 »
2009-04-04 update documentation.
158
f420bf7b »
2009-08-02 support different Analyzer's at index and query time.
159 <h3>The Analyzer Option</h3>
160
161 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;
162
163 <ul>
164 <li>brazilian</li>
165 <li>chinese</li>
166 <li>cjk</li>
167 <li>czech</li>
168 <li>dutch</li>
169 <li>english</li>
170 <li>french</li>
171 <li>german</li>
172 <li>keyword</li>
76d290dd »
2010-01-08 add perfield analyzer support
173 <li>perfield</li>
f420bf7b »
2009-08-02 support different Analyzer's at index and query time.
174 <li>porter</li>
175 <li>russian</li>
176 <li>simple</li>
177 <li>standard</li>
178 <li>thai</li>
179 </ul>
180
76d290dd »
2010-01-08 add perfield analyzer support
181 The "perfield" option lets you use a different analyzer for different fields and is configured as follows;
182
183 <pre>
b9ea0b23 »
2010-02-04 tidy document about analyzer
184 "analyzer":"perfield:{field_name:\"analyzer_name\"}"
76d290dd »
2010-01-08 add perfield analyzer support
185 </pre>
186
86569b1a »
2010-01-08 use 'default' consistently.
187 Unless overridden, any field name not specified will be handled by the standard analyzer. To change the default, use the special default field name;
76d290dd »
2010-01-08 add perfield analyzer support
188
189 <pre>
b9ea0b23 »
2010-02-04 tidy document about analyzer
190 "analyzer":"perfield:{default:\"keyword\"}"
76d290dd »
2010-01-08 add perfield analyzer support
191 </pre>
192
087dcec0 »
2009-04-04 update documentation.
193 <h3>The Document class</h3>
194
195 You may construct a new Document instance with;
196
197 <pre>
198 var doc = new Document();
199 </pre>
200
a40523d3 »
2009-04-21 documentation of future features.
201 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.
087dcec0 »
2009-04-04 update documentation.
202
203 <pre>
a40523d3 »
2009-04-21 documentation of future features.
204 // Add with all the defaults.
205 doc.add("value");
206
d2e1e9ea »
2009-08-31 add notes about typing.
207 // Add a numeric field.
38ef3208 »
2010-02-19 fix documentation s/integer/int
208 doc.add(35, {"type":"int"});
d2e1e9ea »
2009-08-31 add notes about typing.
209
46705824 »
2009-08-31 use NumericField. currently broken.
210 // Add a date field.
211 doc.add(new Date("2009-01-01"), {"type":"date"});
212
d2e1e9ea »
2009-08-31 add notes about typing.
213 // Add a date field (object must be a Date object
214
a40523d3 »
2009-04-21 documentation of future features.
215 // Add a subject field.
216 doc.add("this is the subject line.", {"field":"subject"});
9a715570 »
2009-04-05 formatting
217
a40523d3 »
2009-04-21 documentation of future features.
218 // Add but ensure it's stored.
219 doc.add("value", {"store":"yes"});
9a715570 »
2009-04-05 formatting
220
a40523d3 »
2009-04-21 documentation of future features.
221 // Add but don't analyze.
222 doc.add("don't analyze me", {"index":"not_analyzed"});
9a715570 »
2009-04-05 formatting
223
fae7be0e »
2010-03-26 add example for attachment with default field.
224 // Extract text from the named attachment and index it.
225 doc.attachment("attachment name");
226
227 // Extract text from the named attachment and index it to a separate field
a40523d3 »
2009-04-21 documentation of future features.
228 doc.attachment("attachment name", {"field":"attachments"});
9f99f192 »
2010-04-19 add log.info example
229
230 // log an event (trace, debug, info, warn and error are available)
231 if (doc.foo) {
232 log.info("doc has foo property!");
233 }
087dcec0 »
2009-04-04 update documentation.
234 </pre>
235
ccb81a8a »
2009-03-20 add example transforms section.
236 <h3>Example Transforms</h3>
237
390858a2 »
2009-04-05 re-add Index Everything example.
238 <h4>Index Everything</h4>
239
240 <pre>
241 function(doc) {
7bad7dc9 »
2009-04-30 correct syntax error in JS fun.
242 var ret = new Document();
243
244 function idx(obj) {
245 for (var key in obj) {
246 switch (typeof obj[key]) {
247 case 'object':
248 idx(obj[key]);
249 break;
250 case 'function':
251 break;
252 default:
253 ret.add(obj[key]);
254 break;
255 }
256 }
257 };
258
259 idx(doc);
260
261 if (doc._attachments) {
262 for (var i in doc._attachments) {
263 ret.attachment("attachment", i);
264 }
390858a2 »
2009-04-05 re-add Index Everything example.
265 }
d2e1e9ea »
2009-08-31 add notes about typing.
266
7bad7dc9 »
2009-04-30 correct syntax error in JS fun.
267 return ret;
390858a2 »
2009-04-05 re-add Index Everything example.
268 }
269 </pre>
270
ccb81a8a »
2009-03-20 add example transforms section.
271 <h4>Index Nothing</h4>
272
273 <pre>
274 function(doc) {
275 return null;
276 }
277 </pre>
278
c207a604 »
2009-04-04 update README
279 <h4>Index Select Fields</h4>
ccb81a8a »
2009-03-20 add example transforms section.
280
281 <pre>
282 function(doc) {
c207a604 »
2009-04-04 update README
283 var result = new Document();
c6356fd5 »
2009-04-26 update README.md and TODO to reflect progress.
284 result.add(doc.subject, {"field":"subject", "store":"yes"});
285 result.add(doc.content, {"field":"subject"});
5cfa20cf »
2009-12-23 fix error in example
286 result.add(new Date(), {"field":"indexed_at"});
c207a604 »
2009-04-04 update README
287 return result;
ccb81a8a »
2009-03-20 add example transforms section.
288 }
289 </pre>
290
c207a604 »
2009-04-04 update README
291 <h4>Index Attachments</h4>
ccb81a8a »
2009-03-20 add example transforms section.
292
293 <pre>
294 function(doc) {
c207a604 »
2009-04-04 update README
295 var result = new Document();
296 for(var a in doc._attachments) {
244df305 »
2009-10-10 fix mistake in README
297 result.attachment(a, {"field":"attachment"});
ccb81a8a »
2009-03-20 add example transforms section.
298 }
c207a604 »
2009-04-04 update README
299 return result;
300 }
301 </pre>
302
303 <h4>A More Complex Example</h4>
304
305 <pre>
306 function(doc) {
307 var mk = function(name, value, group) {
c6356fd5 »
2009-04-26 update README.md and TODO to reflect progress.
308 var ret = new Document();
2946c9ae »
2009-05-06 fix example.
309 ret.add(value, {"field": group, "store":"yes"});
c6356fd5 »
2009-04-26 update README.md and TODO to reflect progress.
310 ret.add(group, {"field":"group", "store":"yes"});
c207a604 »
2009-04-04 update README
311 return ret;
312 };
313 if(doc.type != "reference") return null;
a313b24f »
2009-11-17 lots of stuff.
314 var ret = new Array();
c207a604 »
2009-04-04 update README
315 for(var g in doc.groups) {
a313b24f »
2009-11-17 lots of stuff.
316 ret.push(mk("library", doc.groups[g].library, g));
317 ret.push(mk("method", doc.groups[g].method, g));
318 ret.push(mk("target", doc.groups[g].target, g));
c207a604 »
2009-04-04 update README
319 }
320 return ret;
321 }
322 </pre>
b2079657 »
2009-02-14 improve README readability.
323
4a600804 »
2009-02-18 use couchdb's content_type rather than auto-detect.
324 <h2>Attachment Indexing</h2>
325
8059ce07 »
2009-03-08 s/couchdb/couchdb-lucene
326 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;
4a600804 »
2009-02-18 use couchdb's content_type rather than auto-detect.
327
ec94e218 »
2009-02-18 updated README.md
328 <h3>Supported Formats</h3>
329
4a600804 »
2009-02-18 use couchdb's content_type rather than auto-detect.
330 <ul>
331 <li>Excel spreadsheets (application/vnd.ms-excel)
332 <li>HTML (text/html)
333 <li>Images (image/*)
334 <li>Java class files
335 <li>Java jar archives
336 <li>MP3 (audio/mp3)
337 <li>OpenDocument (application/vnd.oasis.opendocument.*)
f420bf7b »
2009-08-02 support different Analyzer's at index and query time.
338 <li>Outlook (application/vnd.ms-outlook)
4a600804 »
2009-02-18 use couchdb's content_type rather than auto-detect.
339 <li>PDF (application/pdf)
f420bf7b »
2009-08-02 support different Analyzer's at index and query time.
340 <li>Plain text (text/plain)
341 <li>Powerpoint presentations (application/vnd.ms-powerpoint)
4a600804 »
2009-02-18 use couchdb's content_type rather than auto-detect.
342 <li>RTF (application/rtf)
f420bf7b »
2009-08-02 support different Analyzer's at index and query time.
343 <li>Visio (application/vnd.visio)
344 <li>Word documents (application/msword)
345 <li>XML (application/xml)
4a600804 »
2009-02-18 use couchdb's content_type rather than auto-detect.
346 </ul>
347
b2079657 »
2009-02-14 improve README readability.
348 <h1>Searching with couchdb-lucene</h1>
349
2b14b76d »
2009-12-24 describ syntax for all forms of numeric range query
350 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>.
351
352 <h2>Numeric range queries</h2>
353
e0c2000d »
2010-04-18 fix grammar, thanks tisba.
354 In addition to normal text-based range searches (using the "field:[lower TO upper]" syntax), couchdb-lucene also supports numeric range searches for the following types: int, long, float, double and date. The type is specified after the field name, as follows;
2b14b76d »
2009-12-24 describ syntax for all forms of numeric range query
355
356 <table>
bf989bc2 »
2010-01-21 make type of range query explicit.
357 <tr><td>type</td><td>example</td></tr>
38ef3208 »
2010-02-19 fix documentation s/integer/int
358 <tr><td>int</td><td>field&lt;int>:[0 TO 100]</td></tr>
20c9be3a »
2010-01-21 update docs on numeric range queries
359 <tr><td>long</td><td>field&lt;long>:[0 TO 100]</td></tr>
360 <tr><td>float</td><td>field&lt;float>:[0.0 TO 100.0]</td></tr>
361 <tr><td>double</td><td>field&lt;double>:[0.0 TO 100.0]</td></tr>
362 <tr><td>date</td><td>field&lt;date>:[2001-01-01 TO 2010-01-01] or field&lt;date>:[2000-01-01T00:00:00-0500 TO 2010-01-01T00:00:00-0500]</td></tr>
2b14b76d »
2009-12-24 describ syntax for all forms of numeric range query
363 </table>
364
460f5c6a »
2010-01-09 add example spatial/geographical query
365 An example numeric range query for spatial searching.
366
367 <pre>
1217f9f2 »
2010-01-21 update docs on numeric range queries
368 ?q=pizza AND lat&lt;double>:[51.4707 TO 51.5224] AND long&lt;double>:[-0.6622 TO -0.5775]
460f5c6a »
2010-01-09 add example spatial/geographical query
369 </pre>
370
2b14b76d »
2009-12-24 describ syntax for all forms of numeric range query
371 The following parameters can be passed for more sophisticated searches;
b2079657 »
2009-02-14 improve README readability.
372
373 <dl>
f420bf7b »
2009-08-02 support different Analyzer's at index and query time.
374 <dt>callback</dt><dd>Specify a JSONP callback wrapper. The full JSON result will be prepended with this parameter and also placed with parentheses."
71cbc0bf »
2009-08-02 correct description of debug setting.
375 <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>
ea19e554 »
2009-08-12 add force_json=true to force 'application/json' response type.
376 <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>
f420bf7b »
2009-08-02 support different Analyzer's at index and query time.
377 <dt>include_docs</dt><dd>whether to include the source docs</dd>
f9c61e32 »
2009-03-22 format README
378 <dt>limit</dt><dd>the maximum number of results to return</dd>
766d8741 »
2010-01-04 support multiple q parameters in one call.
379 <dt>q</dt><dd>the query to run (e.g, subject:hello). If not specified, the default field is searched. Multiple q parameters are permitted, the resulting JSON will be an array of responses.</dd>
f9c61e32 »
2009-03-22 format README
380 <dt>skip</dt><dd>the number of results to skip</dd>
8f30f2d8 »
2010-01-21 make typed sort the same syntax as typed range search.
381 <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 the type between angle brackets (e.g, 'sort=amount<float>'). Supported types are 'float', 'double', 'int', 'long' and 'date'.</dd>
637279a5 »
2009-07-11 fix grammar in readme.
382 <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>
ad9096f2 »
2009-02-14 tweak README.md
383 </dl>
b2079657 »
2009-02-14 improve README readability.
384
385 <i>All parameters except 'q' are optional.</i>
386
ec94e218 »
2009-02-18 updated README.md
387 <h2>Special Fields</h2>
388
389 <dl>
087dcec0 »
2009-04-04 update documentation.
390 <dt>_id</dt><dd>The _id of the document.</dd>
46a3a371 »
2009-03-08 include all DC attributes, if present.
391 </dl>
392
393 <h2>Dublin Core</h2>
394
395 All Dublin Core attributes are indexed and stored if detected in the attachment. Descriptions of the fields come from the Tika javadocs.
396
397 <dl>
6e99faa7 »
2009-05-04 dc. to _dc.
398 <dt>_dc.contributor</dt><dd> An entity responsible for making contributions to the content of the resource.</dd>
399 <dt>_dc.coverage</dt><dd>The extent or scope of the content of the resource.</dd>
400 <dt>_dc.creator</dt><dd>An entity primarily responsible for making the content of the resource.</dd>
401 <dt>_dc.date</dt><dd>A date associated with an event in the life cycle of the resource.</dd>
402 <dt>_dc.description</dt><dd>An account of the content of the resource.</dd>
403 <dt>_dc.format</dt><dd>Typically, Format may include the media-type or dimensions of the resource.</dd>
404 <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>
405 <dt>_dc.language</dt><dd>A language of the intellectual content of the resource.</dd>
406 <dt>_dc.modified</dt><dd>Date on which the resource was changed.</dd>
407 <dt>_dc.publisher</dt><dd>An entity responsible for making the resource available.</dd>
408 <dt>_dc.relation</dt><dd>A reference to a related resource.</dd>
409 <dt>_dc.rights</dt><dd>Information about rights held in and over the resource.</dd>
410 <dt>_dc.source</dt><dd>A reference to a resource from which the present resource is derived.</dd>
411 <dt>_dc.subject</dt><dd>The topic of the content of the resource.</dd>
412 <dt>_dc.title</dt><dd>A name given to the resource.</dd>
413 <dt>_dc.type</dt><dd>The nature or genre of the content of the resource.</dd>
ec94e218 »
2009-02-18 updated README.md
414 </dl>
415
b2079657 »
2009-02-14 improve README readability.
416 <h2>Examples</h2>
417
418 <pre>
6b73dc6c »
2010-04-17 commit to _design/foo in paths, use regexp to be sure.
419 http://localhost:5984/dbname/_fti/_design/foo/view_name?q=field_name:value
420 http://localhost:5984/dbname/_fti/_design/foo/view_name?q=field_name:value&sort=other_field
421 http://localhost:5984/dbname/_fti/_design/foo/view_name?debug=true&sort=billing_size&q=body:document AND customer:[A TO C]
b2079657 »
2009-02-14 improve README readability.
422 </pre>
423
424 <h2>Search Results Format</h2>
425
0fcf5787 »
2009-04-26 update docs.
426 The search result contains a number of fields at the top level, in addition to your search results.
427
428 <dl>
429 <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>
430 <dt>fetch_duration</dt><dd>The number of milliseconds spent retrieving the documents.</dd>
f420bf7b »
2009-08-02 support different Analyzer's at index and query time.
431 <dt>limit</dt><dd>The maximum number of results that can appear.</dd>
432 <dt>q</dt><dd>The query that was executed.</dd>
24591d91 »
2009-04-26 docs
433 <dt>rows</dt><dd>The search results array, described below.</dd>
f420bf7b »
2009-08-02 support different Analyzer's at index and query time.
434 <dt>search_duration</dt><dd>The number of milliseconds spent performing the search.</dd>
435 <dt>skip</dt><dd>The number of initial matches that was skipped.</dd>
436 <dt>total_rows</dt><dd>The total number of matches for this query.</dd>
0fcf5787 »
2009-04-26 update docs.
437 </dl>
438
24591d91 »
2009-04-26 docs
439 <h2>The search results array</h2>
440
441 The search results arrays consists of zero, one or more objects with the following fields;
0fcf5787 »
2009-04-26 update docs.
442
443 <dl>
f420bf7b »
2009-08-02 support different Analyzer's at index and query time.
444 <dt>doc</dt><dd>The original document from couch, if requested with include_docs=true</dd>
445 <dt>fields</dt><dd>All the fields that were stored with this match</dd>
0fcf5787 »
2009-04-26 update docs.
446 <dt>id</dt><dd>The unique identifier for this match.</dd>
447 <dt>score</dt><dd>The normalized score (0.0-1.0, inclusive) for this match</dd>
448 </dl>
449
fd163159 »
2009-03-07 update README.md
450 Here's an example of a JSON response without sorting;
b2079657 »
2009-02-14 improve README readability.
451
118d28eb »
2009-02-17 JSON example output.
452 <pre>
453 {
c6356fd5 »
2009-04-26 update README.md and TODO to reflect progress.
454 "q": "+content:enron",
fd163159 »
2009-03-07 update README.md
455 "skip": 0,
456 "limit": 2,
457 "total_rows": 176852,
458 "search_duration": 518,
459 "fetch_duration": 4,
460 "rows": [
461 {
0fcf5787 »
2009-04-26 update docs.
462 "id": "hain-m-all_documents-257.",
fd163159 »
2009-03-07 update README.md
463 "score": 1.601625680923462
464 },
465 {
0fcf5787 »
2009-04-26 update docs.
466 "id": "hain-m-notes_inbox-257.",
fd163159 »
2009-03-07 update README.md
467 "score": 1.601625680923462
468 }
118d28eb »
2009-02-17 JSON example output.
469 ]
470 }
471 </pre>
472
fd163159 »
2009-03-07 update README.md
473 And the same with sorting;
474
118d28eb »
2009-02-17 JSON example output.
475 <pre>
476 {
0fcf5787 »
2009-04-26 update docs.
477 "q": "+content:enron",
fd163159 »
2009-03-07 update README.md
478 "skip": 0,
479 "limit": 3,
480 "total_rows": 176852,
481 "search_duration": 660,
482 "fetch_duration": 4,
483 "sort_order": [
484 {
485 "field": "source",
486 "reverse": false,
487 "type": "string"
488 },
489 {
490 "reverse": false,
491 "type": "doc"
492 }
118d28eb »
2009-02-17 JSON example output.
493 ],
fd163159 »
2009-03-07 update README.md
494 "rows": [
495 {
0fcf5787 »
2009-04-26 update docs.
496 "id": "shankman-j-inbox-105.",
fd163159 »
2009-03-07 update README.md
497 "score": 0.6131107211112976,
498 "sort_order": [
499 "enron",
500 6
501 ]
502 },
503 {
0fcf5787 »
2009-04-26 update docs.
504 "id": "shankman-j-inbox-8.",
fd163159 »
2009-03-07 update README.md
505 "score": 0.7492915391921997,
506 "sort_order": [
507 "enron",
508 7
509 ]
510 },
511 {
0fcf5787 »
2009-04-26 update docs.
512 "id": "shankman-j-inbox-30.",
fd163159 »
2009-03-07 update README.md
513 "score": 0.507369875907898,
514 "sort_order": [
515 "enron",
516 8
517 ]
518 }
118d28eb »
2009-02-17 JSON example output.
519 ]
520 }
521 </pre>
522
a4aa4e14 »
2009-08-02 document Content-Type response negotiation
523 <h3>Content-Type of response</h3>
524
d2e1e9ea »
2009-08-31 add notes about typing.
525 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.
a4aa4e14 »
2009-08-02 document Content-Type response negotiation
526
139a78cc »
2009-03-09 add info retrieval.
527 <h1>Fetching information about the index</h1>
528
0cf49410 »
2010-01-10 correct info urls.
529 Calling couchdb-lucene without arguments returns a JSON object with information about the index.
139a78cc »
2009-03-09 add info retrieval.
530
531 <pre>
6b73dc6c »
2010-04-17 commit to _design/foo in paths, use regexp to be sure.
532 http://127.0.0.1:5984/&lt;db>/_fti/_design/foo/&lt;index
139a78cc »
2009-03-09 add info retrieval.
533 </pre>
534
535 returns;
536
537 <pre>
f6ac0483 »
2010-01-10 line breaks
538 {"current":true,"disk_size":110674,"doc_count":397,"doc_del_count":0,
539 "fields":["default","number"],"last_modified":"1263066382000",
540 "optimized":true,"ref_count":2}
139a78cc »
2009-03-09 add info retrieval.
541 </pre>
8203af64 »
2010-01-10 support _optimize and _expunge calls.
542
543 <h1>Index Maintenance</h1>
544
545 For optimal query speed you can optimize your indexes. This causes the index to be rewritten into a single segment.
546
547 <pre>
6b73dc6c »
2010-04-17 commit to _design/foo in paths, use regexp to be sure.
548 curl -X POST http://localhost:5984/&lt;db>/_fti/_design/foo/&lt;index>/_optimize
8203af64 »
2010-01-10 support _optimize and _expunge calls.
549 </pre>
550
551 If you just want to expunge pending deletes, then call;
552
553 <pre>
6b73dc6c »
2010-04-17 commit to _design/foo in paths, use regexp to be sure.
554 curl -X POST http://localhost:5984/&lt;db>/_fti/_design/foo/&lt;index>/_expunge
8203af64 »
2010-01-10 support _optimize and _expunge calls.
555 </pre>
6e66766f »
2010-01-31 most of index cleanup work
556
557 If you recreate databases or frequently change your fulltext functions, you will probably have old indexes lying around on disk. To remove all of them, call;
558
559 <pre>
560 curl -X POST http://localhost:5984/&lt;db>/_fti/_cleanup
561 </pre>
Something went wrong with that request. Please try again.