Skip to content

Latest commit

 

History

History
78 lines (60 loc) · 3 KB

README.md

File metadata and controls

78 lines (60 loc) · 3 KB
Raw

Background

I created this project to enable the use of couchdb-lucene with ektorp for couchdb. The Ektorp project does not directly support couchdb-lucene as it is not core to couchdb lucene.

Version 0.1.1 supports ektorp 1.0.2 Version 0.1.2 supports ektorp 1.1.0 Version 0.1.3 supports ektorp 1.1.1 Version 0.1.4 supports ektorp 1.2.2 Version 0.2.0 supports ektorp 1.4.1 and couchdb-lucene 0.9.0

Minimum System Requirement

Java 1.5 (or Above) is required. Personally I use Sun Java 7

Issue Tracking

Issue tracking at github.

Overview/Usage

This is a really basic package. Please Read Ektorp Minimal Configuration first. LuceneAwareCouchDbConnector extends, and basically replaces, StdCouchDbConnector in that case:

HttpClient httpClient = new StdHttpClient.Builder().build()
CouchDbInstance dbInstance = new StdCouchDbInstance(httpClient);
LuceneAwareCouchDbConnector db = new LuceneAwareCouchDbConnector("my_first_database", dbInstance);
db.createDatabaseIfNotExists();

LuceneQuery is then a tool that builds the couchdb-lucene query, anything in that pojo should match the arguments for couchdb-lucene.

Using a LuceneQuery one can then call luceneAwareCouchDbConnector.queryLucene. This returns a LuceneResult, that should match the response from couchdb-lucene.

Creating Indexes

You can create indexes the same way you can create Views in Ektorp, you just need to follow a few steps:

  • Extend CouchDbRepositorySupportWithLucene instead of CouchDbRepositorySupport for your Repository classes
  • Annotate using @Fulltext and @Index to create indexes
  • Call initStandardDesignDocument() to generate the design document

Example:

@FullText({
	@Index(
		name = "by_title",
		index = "function(doc) { " +
					"var res = new Document(); " +
					"res.add(doc.title);" +
					"return res; " +
				"}")
})
public class CouchDBArtifactRepository extends CouchDbRepositorySupportWithLucene<Artifact> {
    
    public CouchDBArtifactRepository(LuceneAwareCouchDbConnector db) {
		super(Artifact.class, db);
		initStandardDesignDocument();
    }
    
}

This will generate a "fulltext" attribute for your design document:

...
"fulltext": {
    "by_title": {
        "index": "function(doc) { var res = new Document(); res.add(doc.title); return res; }"
    }
},
...

If you don't set the environment variable org.ektorp.support.UpdateDesignDocOnDiff to true, you will need to delete your design document for indexes to be created.

Maven

EktorpLucene is now available in the maven repositories. Please at this to your dependencies: com.github.ldriscoll ektorplucene 0.2.0

Sample

Please take a look at LuceneSearchTest.testSearch for a basic sample of how to use it.