Welcome to pocketsearch’s documentation!

pocketsearch is a pure-Python full text indexing search library based on sqlite and its FTS5 extension.

It provides

• A simple API (inspired by the ORM layer of the Django web framework) for defining schemas and searching - no need to write SQL

• Multi-field indices using schemas including text, numeric and date/datetime search

• Prefix, phrase and initial token queries

• Spell checker and query auto correction

• Boolean search queries

• Highlightning search results and extracting snippets

• Autocomplete features

It does not have any external dependencies other than Python itself. pocketsearch has been tested on Python 3.8, Python 3.9, Python 3.10 and Python 3.11.

• Installation
• Getting started
• Reading and writing search indices
  • PocketReader and PocketWriter classes
• Defining Schemas
  • Field types
  • Field options
  • Selecting data using custom schemas
  • Inserting data
  • Updating data
  • Insert or update method
  • Deleting data
  • Improving performance: Write buffers
• Basic searches
  • The .search method
  • Prefix queries
  • Initial token queries
  • Phrase queries
• Boolean searches
  • AND/OR queries on a single field
  • AND queries on multiple fields
  • OR queries on multiple fields
• Searching non-text data
  • Searching numeric data
  • Searching date fields
• Formatting search results
  • Highlighting results
  • Extracting snippets from text
• Autocomplete queries
• Spell checker
  • Enabling spell checking
  • Using spellchecking
  • Limitations
• Advanced options
  • Tokenization
  • Index meta data
  • Prefix indices
  • Behind the scenes: how searching works
  • Optimizing the index for query performance
• Contribute
• License