# API Reference


## Engine


Pythonic wrapper around PyLucene.


[engine.Analyzer](engine.Analyzer.md#lupyne.engine.Analyzer)  
Return a lucene Analyzer which chains together a tokenizer and filters.

[engine.TokenFilter](engine.TokenFilter.md#lupyne.engine.TokenFilter)  
Create an iterable lucene TokenFilter from a TokenStream.

[engine.DateTimeField](engine.DateTimeField.md#lupyne.engine.DateTimeField)  
Field which indexes datetimes as Point fields of timestamps.

[engine.Document](engine.Document.md#lupyne.engine.Document)  
Multimapping of field names to values, but default getters return the first value.

[engine.Field](engine.Field.md#lupyne.engine.Field)  
Saved parameters which can generate lucene Fields given values.

[engine.NestedField](engine.NestedField.md#lupyne.engine.NestedField)  
Field which indexes every component into its own field.

[engine.ShapeField](engine.ShapeField.md#lupyne.engine.ShapeField)  
Field which indexes geometries: LatLon or XY.

[engine.Indexer](engine.Indexer.md#lupyne.engine.Indexer)  
An all-purpose interface to an index.

[engine.IndexSearcher](engine.IndexSearcher.md#lupyne.engine.IndexSearcher)  
Inherited lucene IndexSearcher, with a mixed-in IndexReader.

[engine.IndexWriter](engine.IndexWriter.md#lupyne.engine.IndexWriter)  
Inherited lucene IndexWriter.

[engine.MultiSearcher](engine.MultiSearcher.md#lupyne.engine.MultiSearcher)  
IndexSearcher with underlying lucene MultiReader.

[engine.Query](engine.Query.md#lupyne.engine.Query)  
Inherited lucene Query, with dynamic base class acquisition.