From f9c61e32d9277d6a596dbc0b874b16b940d37f1b Mon Sep 17 00:00:00 2001 From: Robert Newson Date: Sun, 22 Mar 2009 12:55:01 +0000 Subject: [PATCH] format README --- README.md | 62 +++++++++++++++++++++++++++---------------------------- 1 file changed, 31 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 3e31708a..afc2ba80 100644 --- a/README.md +++ b/README.md @@ -120,14 +120,14 @@ Couchdb-lucene uses Apache Tika to You can perform all types of queries using Lucene's default query syntax. The following parameters can be passed for more sophisticated searches;
-
q
the query to run (e.g, subject:hello) -
sort
the comma-separated fields to sort on. Prefix with / for ascending order and \ for descending order (ascending is the default if not specified). -
limit
the maximum number of results to return -
skip
the number of results to skip -
include_docs
whether to include the source docs -
stale=ok
If you set the stale option ok, 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. -
debug
if false, a normal application/json response with results appears. if true, an pretty-printed HTML blob is returned instead. -
rewrite
(EXPERT) if true, returns a json response with a rewritten query and term frequencies. This allows correct distributed scoring when combining the results from multiple nodes. +
q
the query to run (e.g, subject:hello)
+
sort
the comma-separated fields to sort on. Prefix with / for ascending order and \ for descending order (ascending is the default if not specified).
+
limit
the maximum number of results to return
+
skip
the number of results to skip
+
include_docs
whether to include the source docs
+
stale=ok
If you set the stale option ok, 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.
+
debug
if false, a normal application/json response with results appears. if true, an pretty-printed HTML blob is returned instead.
+
rewrite
(EXPERT) if true, returns a json response with a rewritten query and term frequencies. This allows correct distributed scoring when combining the results from multiple nodes.
All parameters except 'q' are optional. @@ -135,9 +135,9 @@ You can perform all types of queries using Lucene's default -
dc.contributor
An entity responsible for making contributions to the content of the resource. -
dc.coverage
The extent or scope of the content of the resource. -
dc.creator
An entity primarily responsible for making the content of the resource. -
dc.date
A date associated with an event in the life cycle of the resource. -
dc.description
An account of the content of the resource. -
dc.format
Typically, Format may include the media-type or dimensions of the resource. -
dc.identifier
Recommended best practice is to identify the resource by means of a string or number conforming to a formal identification system. -
dc.language
A language of the intellectual content of the resource. -
dc.modified
Date on which the resource was changed. -
dc.publisher
An entity responsible for making the resource available. -
dc.relation
A reference to a related resource. -
dc.rights
Information about rights held in and over the resource. -
dc.source
A reference to a resource from which the present resource is derived. -
dc.subject
The topic of the content of the resource. -
dc.title
A name given to the resource. -
dc.type
The nature or genre of the content of the resource. +
dc.contributor
An entity responsible for making contributions to the content of the resource.
+
dc.coverage
The extent or scope of the content of the resource.
+
dc.creator
An entity primarily responsible for making the content of the resource.
+
dc.date
A date associated with an event in the life cycle of the resource.
+
dc.description
An account of the content of the resource.
+
dc.format
Typically, Format may include the media-type or dimensions of the resource.
+
dc.identifier
Recommended best practice is to identify the resource by means of a string or number conforming to a formal identification system.
+
dc.language
A language of the intellectual content of the resource.
+
dc.modified
Date on which the resource was changed.
+
dc.publisher
An entity responsible for making the resource available.
+
dc.relation
A reference to a related resource.
+
dc.rights
Information about rights held in and over the resource.
+
dc.source
A reference to a resource from which the present resource is derived.
+
dc.subject
The topic of the content of the resource.
+
dc.title
A name given to the resource.
+
dc.type
The nature or genre of the content of the resource.

Examples

@@ -276,8 +276,8 @@ You will need to restart CouchDB if you change couchdb-lucene source code but th couchdb-lucene respects several system properties;
-
couchdb.url
the url to contact CouchDB with (default is "http://localhost:5984") -
couchdb.lucene.dir
specify the path to the lucene indexes (the default is to make a directory called 'lucene' relative to couchdb's current working directory. +
couchdb.url
the url to contact CouchDB with (default is "http://localhost:5984")
+
couchdb.lucene.dir
specify the path to the lucene indexes (the default is to make a directory called 'lucene' relative to couchdb's current working directory.
You can override these properties like this; @@ -294,6 +294,6 @@ com.github.rnewson.couchdb.lucene.Main If you put couchdb behind an authenticating proxy you can still configure couchdb-lucene to pull from it by specifying additional system properties. Currently only Basic authentication is supported.
-
couchdb.user
the user to authenticate as. -
couchdb.password
the password to authenticate with. +
couchdb.user
the user to authenticate as.
+
couchdb.password
the password to authenticate with.