server

Restful json CherryPy server.

CherryPy and Lucene VM integration issues:

• Monitors (such as autoreload) are not compatible with the VM unless threads are attached.
• WorkerThreads must be also attached to the VM.
• VM initialization must occur after daemonizing.
• Recommended that the VM ignores keyboard interrupts (-Xrs) for clean server shutdown.

Usage: python server.py [index_directory ...]

Options:

-h, --help	show this help message and exit
-r, --read-only
	expose only read methods; no write lock
-c CONFIG, --config=CONFIG
	optional configuration file or json object of global params
-p FILE, --pidfile=FILE
	store the process id in the given file
-d, --daemonize
	run the server as a daemon
--autoreload=SECONDS
	automatically reload modules; replacement for engine.autoreload
--autorefresh=SECONDS
	automatically refresh index

tools

server.json_(indent=None)

Transform responses into json format. Specify tools.json.indent for pretty printing.

server.allow(methods=('GET', 'HEAD'))

Only allow methods specified in tools.allow.methods.

server.time_()

Return response time in headers.

WebSearcher

class server.WebSearcher(*directories, **kwargs)

Dispatch root with a delegated Searcher.

docs(id=None, fields=None, **options)

Return ids or documents.

GET /docs

Return list of doc ids.

return:[int,... ]

GET /docs/int?

Return document mappings, optionally selecting stored, multi-valued, and cached indexed fields.

&fields=chars,... &fields.multi=chars,... &fields.indexed=chars[:chars],...

return:{string: string|array,... }

index()

Return index information.

GET /

Return a mapping of the directory to the document count.

return:{string: int}

refresh(**caches)

Refresh index.

POST /refresh

Reopen searcher, optionally reloading caches, and return document count.

&filters&sorters&spellcheckers

return:int

search(q=None, count=None, start=0, fields=None, sort=None, facets='', group='', hl='', mlt=None, spellcheck=0, timeout=None, **options)

Run query and return documents.

GET /search?

Return list of document objects and total doc count.

&q=chars&q.type=[term|prefix|wildcard]&q.chars=...,

query, optional type to skip parsing, and optional parser settings: q.field, q.op,...

&filter=chars

cached filter applied to the query

if a previously cached filter is not found, the value will be parsed as a query

&count=int&start=0

maximum number of docs to return and offset to start at

&fields=chars,... &fields.multi=chars,... &fields.indexed=chars[:chars],...

only include selected stored fields; multi-valued fields returned in an array; indexed fields are cached

&sort=[-]chars[:chars],... &sort.scores[=max]

field name, optional type, minus sign indicates descending

optionally score docs, additionally compute maximum score

&facets=chars,...

include facet counts for given field names; facets filters are cached

&group=chars&group.count=1

group documents by field value, up to given maximum count

&hl=chars,... &hl.count=1&hl.tag=strong&hl.enable=[fields|terms]

stored fields to return highlighted

optional maximum fragment count and html tag name

optionally enable matching any field or any term

&mlt=int&mlt.fields=chars,... &mlt.chars=...,

doc index (or id without a query) to find MoreLikeThis

optional document fields to match

optional MoreLikeThis settings: mlt.minTermFreq, mlt.minDocFreq,...

&spellcheck=int

maximum number of spelling corrections to return for each query term, grouped by field

original query is still run; use q.spellcheck=true to affect query parsing

&timeout=float

timeout search after elapsed number of seconds

return:

{

“query”: string,

“count”: int|null,

“maxscore”: float|null,

“docs”: [{“__id__”: int, “__score__”: float, “__highlights__”: {string: array,... }, string: string|array,... },... ],

“facets”: {string: {string: int,... },... },

“groups”: [{“count”: int, “value”: value, “docs”: [{... },... ]},... ]

“spellcheck”: {string: {string: [string,... ],... },... },

}

terms(name='', value=':', docs='', counts='', **options)

Return data about indexed terms.

GET /terms?

Return field names, with optional selection.

&option=chars

return:[string,... ]

GET /terms/chars

Return term values for given field name.

return:[string,... ]

GET /terms/chars/chars[*|?|:chars|~float]

Return term values (wildcards, slices, or fuzzy terms) for given field name.

return:[string,... ]

GET /terms/chars/chars[*|~]?count=int

Return spellchecked term values ordered by decreasing document frequency. Prefixes (*) are optimized to be suitable for real-time query suggestions; all terms are cached.

return:[string,... ]

GET /terms/chars/chars

Return document count with given term.

return:int

GET /terms/chars/chars/docs

Return document ids with given term.

return:[int,... ]

GET /terms/chars/chars/docs/counts

Return document ids and frequency counts for given term.

return:[[int, int],... ]

GET /terms/chars/chars/docs/positions

Return document ids and positions for given term.

return:[[int, [int,... ]],... ]

WebIndexer

class server.WebIndexer(*args, **kwargs)

Bases: server.WebSearcher

Dispatch root which extends searcher to include write methods.

commit(**caches)

Commit index changes.

POST /commit

Commit write operations and return document count. See WebSearcher.refresh() for caching options.

docs(id=None, docs='[]', fields=None, **options)

Add or return documents. See WebSearcher.docs() for GET method.

POST /docs

Add documents to index.

docs=[{string: string|array,... },... ]

fields(name='', **params)

Return or store a field’s parameters.

GET /fields

Return known field names.

return:[string,... ]

GET, PUT /fields/chars

Set and return parameters for given field name.

store=chars

index=chars

termvector=chars

return:{“store”: string, “index”: string, “termvector”: string}

search(q=None, **options)

Run or delete a query. See WebSearcher.search() for GET method.

DELETE /search?q=chars

Delete documents which match query.

start

server.start(root=None, path='', config=None, pidfile='', daemonize=False, autoreload=0, autorefresh=0, callback=None)

Attach root, subscribe to plugins, and start server.

Parameters:

• root,path,config – see cherrypy.quickstart
• pidfile,daemonize,autoreload,autorefresh – see command-line options
• callback – optional callback function scheduled after daemonizing