All notable changes to this project will be documented in this file. The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Breaking: the bm25-named API has been renamed to paradedb, and indexes always use the
paradedbindex access method (requires pg_search 0.25.0+).BM25Fieldis nowParadeDBField,validate_bm25_indexis nowvalidate_paradedb_index, the Alembic operationsop.create_bm25_index/op.drop_bm25_index/op.reindex_bm25are nowop.create_paradedb_index/op.drop_paradedb_index/op.reindex_paradedb(with operation classesCreateParadeDBIndexOp/DropParadeDBIndexOp/ReindexParadeDBOp), and the errorsBM25ValidationError/InvalidBM25FieldErrorare nowParadeDBValidationError/InvalidParadeDBFieldError.Index(postgresql_using="paradedb")is the only recognized access method; index DDL always emitsUSING paradedb. Existing migrations that call the bm25-named operations must be updated to the paradedb names.
- Documentation and copy.
0.7.0 - 2026-06-12
- BREAKING: The
document_idsparameter frommore_like_thiswas removed. To replicate the same behavior, combine multiple single-id more like this queries withor.
0.6.0 - 2026-04-21
- BREAKING: Streamlined the index creation tokenizer API and introduced it to the query interface.
0.5.0 - 2026-04-16
- Added support for passing tokenizer params in query functions.
0.4.0 - 2026-04-13
- Added support for passing functions into queries such as
search.term(Table1.field1, func.trim(keyword)).
0.3.0 - 2026-04-07
- Fixed support for auto-generating migrations using Alembic.
0.2.0 - 2026-04-01
- The ability to pass
StrEnums as parameters into queries.
0.1.0 - 2026-03-25
- Full BM25 search/query helper set with advanced operators.
- Facet and aggregation builders plus rows+facets helper.
- Alembic custom operations and autogenerate render hooks.
- Centralized validation helpers and expanded runtime guard errors.
- Unit/integration suites for indexing, querying, facets, and migrations.
- CI workflow for lint, typing, unit, and integration checks.
- Example scripts for quickstart, facets, autocomplete, MLT, hybrid RRF, and RAG retrieval.