Browse files

Add documentation on proposed enhancements to the indexing API for 0.3.

  • Loading branch information...
1 parent fffe66e commit 5e4e181158f49ccdaee988e1b646cc94d92d72ce Robert Newson committed Apr 10, 2009
Showing with 26 additions and 1 deletion.
  1. +3 −1 README.md
  2. +23 −0 TODO
View
4 README.md
@@ -1,6 +1,8 @@
<h1>News</h1>
-The indexing API has completely changed, please re-read this document and report any surprises/bugs to the bug tracker;
+The indexing API in 0.3 will change once again to allow multiple design documents and "views" into Lucene. It will also move much of the Lucene-specific stuff into an options object. Please read the TODO for details.
+
+The indexing API in 0.2 has completely changed, please re-read this document and report any surprises/bugs to the bug tracker;
Issue tracking now available at <a href="http://rnewson.lighthouseapp.com/projects/27420-couchdb-lucene"/>lighthouseapp</a>.
View
23 TODO
@@ -1,3 +1,26 @@
+Indexing API.
+
+This is going to become much more like the view API in 0.3.
+
+Specifically, you will add attributes to a design document of your own choosing and you will be able to specify multiple transform functions. Access to results will also require the name of the design document and the view name.
+
+{
+ "views": { ... }
+ "fulltext":
+ {
+ "view1": {
+ "defaults": {"field": "data", "index": "analyzed", "store": "no"},
+ "index": "function(doc) { var ret = new Document(); ret.add(doc.subject); ret.add(doc.body); return ret; }"
+ },
+ "view2": {
+ "index": "function(doc) { var ret = new Document(); doc.add(doc.subject, {"field":"subject"}); return ret; }"
+ }
+ }
+}
+
+Note also that the transform function is now called 'index' and has changed in syntax to be less Lucene-centric.
+
+
Performance
* Allow customization of mf/mmb/optimize.

0 comments on commit 5e4e181

Please sign in to comment.