engine.IndexSearcher

Inherited lucene IndexSearcher, with a mixed-in IndexReader.

Usage

engine.IndexSearcher()

Parameters

directory: directory path, lucene Directory, or lucene IndexReader analyzer: lucene Analyzer, default StandardAnalyzer

Attributes

Name	Description
highlighter	lucene UnifiedHighlighter

highlighter

lucene UnifiedHighlighter

highlighter: uhighlight.UnifiedHighlighter

Methods

Name	Description
count()	Return number of hits for given query or term.
facets()	Return mapping of document counts for the intersection with each facet.
get()	Return [Document][lupyne.engine.documents.Document] with only selected fields loaded.
groupby()	Return [Hits][lupyne.engine.documents.Hits] grouped by field
match()	Generate scores for all queries against a given document mapping.
reopen()	Return current [IndexSearcher][lupyne.engine.indexers.IndexSearcher].
search()	Run query and return [Hits][lupyne.engine.documents.Hits].
spans()	Generate docs with occurrence counts for a span query.

count()

Return number of hits for given query or term.

Usage

Source

count(*query, **options)

Args: *query: [search][lupyne.engine.indexers.IndexSearcher.search] compatible query, or optimally a name and value **options: additional [search][lupyne.engine.indexers.IndexSearcher.search] options

facets()

Return mapping of document counts for the intersection with each facet.

Usage

Source

facets(query, *fields, **query_map)

Parameters

query: query string or lucene Query *fields: field names for lucene GroupingSearch **query_map: {facet: {key: query, ...}, ...} for intersected query counts

get()

Return [Document][lupyne.engine.documents.Document] with only selected fields loaded.

Usage

Source

get(id, *fields)

groupby()

Return [Hits][lupyne.engine.documents.Hits] grouped by field

Usage

Source

groupby(field, query, count=None, start=0, **attrs)

using a [GroupingSearch][lupyne.engine.documents.GroupingSearch].

match()

Generate scores for all queries against a given document mapping.

Usage

Source

match(document, *queries)

reopen()

Return current [IndexSearcher][lupyne.engine.indexers.IndexSearcher].

Usage

Source

reopen()

Only creates a new one if necessary.

search()

Run query and return [Hits][lupyne.engine.documents.Hits].

Usage

Source

search(
    query=None,
    count=None,
    sort=None,
    reverse=False,
    scores=False,
    mincount=1000,
    **parser
)

Notes

changed in version 2.3: maxscore option removed; use Hits.maxscore property

Parameters

query: query string or lucene Query count: maximum number of hits to retrieve sort: lucene Sort parameters reverse: reverse flag used with sort scores: compute scores for candidate results when sorting mincount: total hit count accuracy threshold **parser: [parse][lupyne.engine.analyzers.Analyzer.parse]` options

spans()

Generate docs with occurrence counts for a span query.

Usage

Source

spans(query, positions=False)

Parameters

query: lucene SpanQuery positions: optionally include slice positions instead of counts