Apache Lucene Cheat Sheet
|
This section documents the current Apache Lucene 10.x line — Lucene 10 requires Java 21 — as published
at the Apache Lucene documentation and Javadoc, which is the reference these
pages are written and verified against. No specific patch version is pinned; examples target This content was generated with the assistance of AI and should be verified against the official documentation before being relied on in production, as Lucene iterates quickly. This section’s bibliography lists the reference material consulted while preparing these pages. |
A single-page, colour-coded summary of this section’s essentials — one skeleton per major feature area
(build coordinates, the index and search round-trip, the field-type capability matrix, the analysis chain,
the IndexWriterConfig knobs, the core Query builders, points range search, BM25 and Explanation,
function scoring with Sort and searchAfter, CollectorManager concurrent search, taxonomy vs. SSDV
facets, a kNN vector skeleton, the SearcherManager near-real-time loop, the forceMerge / CheckIndex /
IndexUpgrader one-liners, and a Lucene vs. Solr vs. Elasticsearch vs. OpenSearch decision strip) — for
quick lookup rather than explanation. Handy for quick memorization or as a printable desk reference.
For the full explanation, every option, and additional examples, see the dedicated pages:
Getting started — Getting started with Apache Lucene and Architecture & data flow.
Storing & indexing — Directory implementations & storage, Documents, fields & the capability matrix, Indexing operations & merge policies, and Near-real-time search.
Text analysis — Analysis pipeline: Analyzer, TokenStream & attributes, Built-in analyzers & CustomAnalyzer, Token-filter recipes, and Pluggable language modules.
Querying & scoring — Query parsers, The core Query classes, Points & BKD range search, Interval & span queries, Filtering & faceting, Scoring & similarity, Function scoring, expressions & sorting, Collectors & concurrent search, and Reading hits back.
Vectors & specialized search — kNN / HNSW vector search, Spatial search, Highlighting, suggesters, spellcheck, MoreLikeThis & classification, Grouping & joins, and The lucene-monitor module.
Operations & tooling — Performance tuning, Test framework, tools & a module map, and Lucene vs. Solr vs. Elasticsearch vs. OpenSearch.