ChangeLog

Edit page

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.

Unreleased

[1.0.0-alpha.4] - 2026-07-09

Fixed

ICU now links on Apple Silicon. The Homebrew prefix was hardcoded to the Intel path, so find_package(ICU) failed and ICU was silently compiled out of the arm64 build (and its bottle), losing Unicode word-boundary handling despite the formula depending on icu4c.

Changed

The Homebrew formula is head-only and never goes stale: the bottling workflow injects the released tag’s url and a fresh source checksum instead of a pinned default. Asio is fetched by the build rather than declared as a formula dependency.

Removed

Stale contrib: the 2018 FreeBSD ports skeletons, the Django-Haystack backend, and a broken example script.

[1.0.0-alpha.3] - 2026-07-09

Changed

Renamed “indices” to “indexes” throughout: the reserved metadata database is now .xapiand/indexes, and the reference guide follows. A clean break, with no fallback to the old name.
The Python client (xapiand-py) was rewritten as a fully async (asyncio / aiohttp) library and bumped to 1.0.0. There is no synchronous compatibility layer.

[1.0.0-alpha.2] - 2026-07-08

Second alpha: response-path efficiency, a crash-safe data store, a dependency-free test harness, and the full release/CI pipeline. The documentation site moved to Astro/Starlight.

Changed

Zero-copy response logging: the access log reads the response straight from the writer’s buffer instead of copying the body and headers a second time per request. Requests and responses are logged through Kronuz/http-log.
The data store writes a crash-safe v2 volume format (still reads v1).
Documentation migrated from Jekyll to Astro/Starlight, with an Architecture section, D2 diagrams, a rewritten Lua scripting guide, and OS auto-detection on the quick-start.

Added

macOS Homebrew bottles (arm64 + x86_64 via Rosetta), FreeBSD packages, multi-arch Docker images, and RPM/DEB packages, all built on tag push.
ASAN + ThreadSanitizer CI, with the doc-driven E2E run under both.
A request watchdog that flags requests taking too long, and harness/ci_status.sh for one-glance CI status of a ref.
The splash banner shows the build’s git short-hash and version.

Fixed

Aggregations fail clearly on reserved-but-unimplemented types instead of silently returning nothing.
FreeBSD build fixes (<utility> include, __builtin_exp10 lowering); the version now derives from lightweight git tags.
Bumped the cuuid JS dependency to close a uuid advisory (GHSA-w5hq-g745-h8pq).

Removed

GoogleTest: the unit tests run on a dependency-free harness and the legacy test tree was pruned (many suites revived: serialise, endpoint, fieldparser, geospatial HTM, and more).

[1.0.0-alpha.1] - 2026-07-04

First 1.0 milestone (alpha): a broad modernization of the engine, the runtime, and the build, on top of a de-vendored library tree. Six years and 151 commits after 0.40.0. Benchmarked native-vs-native against Elasticsearch and against 0.40.0; see the Benchmarks page.

Changed

Migrated the vendored Xapian engine from the 1.5.0-dev snapshot to 2.0.0 (rebuilt as clean per-feature patches on pristine 2.0.0).
Rebuilt the runtime on an Asio-based reactor and retired libev entirely: the HTTP server, the Xapian remote-backend protocol, the replication protocol, and the discovery/cluster plane (Bus + Raft) all run on the reactor now.
Broke the monolith into a tree of standalone libraries consumed via FetchContent (msgpack, storage, traceback, logger, threadpool, scheduler, datetime, io, fs, system, htm, soundex, and ~20 more), replacing the vendored copies.
Moved to C++20: fmt → std::format, tclap → CLI11, and the ChaiScript scripting engine → Lua (sol2).
Distributed search now runs through one native multi-database Enquire that overlaps the shard fan-out, replacing the serial shard-by-shard loop and the hand-rolled MSet merge.
Data-store volumes and inline document data are written with Zstandard.
Remote protocol synced to Xapian 2.0.0 (v47), as a non-blocking two-phase match the reactor can hold.

Added

Apple Silicon / AArch64 build support.
Native multi-database overlapped shard fan-out (see Changed) and a read-only remote-database stats cache that eliminates the per-query MSG_UPDATE storm.
--color=<mode> log-color control and --discovery-interface selection.
RESTORE streams its request body concurrently (O(buffer) memory).
Content negotiation through the framework (http::AcceptCache).
A full test + benchmark harness: differential E2E capture/check, multi-node cluster liveness checks, a load driver, a native Elasticsearch comparison, and a Remote-protocol proxy/decoder.
Double Metaphone sort key.

Fixed

Distributed query_id made unique per shard, so shards co-located on one node no longer collide in the process-global pending-query map.
A single SIGINT drains in-flight HTTP requests and shuts down the remote and replication layers gracefully.
Data paths (stopwords, mime.types) resolve relative to the executable.
Restored relaxed-JSON parsing, the xapiand_http_requests_summary metric, and the guarantee that an auto-generated _id is never left empty.

Removed

libev, entirely.
The vendored copies of ~30 libraries (now external Kronuz-family deps).
The hand-rolled per-shard fan-out and manual MSet merge, and Xapiand’s bespoke HTTP parser / Request / Response classes (now the http:: library).

0.40.0 - 2020-04-27

Fixed

Added limits to caches without it
Added missing Z to represent UTC on datetimes values
Fix update outdated cache schemas from local and foreign schemas
Fix update cache of index settings when the schema is updated
Increase node lifespan and heartbeat timeout

0.39.0 - 2019-11-19

Fixed

Serialization the get_mset steps due the concurrency produce a segmentation fault

0.38.0 - 2019-10-10

Fixed

Search offsets when merging results

0.37.0 - 2019-09-17

Changed

Raft election timeouts incresed by 2x

0.36.0 - 2019-09-16

Added

Added --primary-node option to fix a primary node

Fixed

Doing GET /.nodes only reads nodes internally

0.35.0 - 2019-08-20

Changed

Improve QueryDSL handling of wildcards and fuzzy

0.34.0 - 2019-08-20

Changed

Allow specifying partial using ** at the end

Fixed

Badly placed Wildcards
Partials for keywords

0.33.0 - 2019-08-19

Changed

Send errors in script as 400
Notify of database changes during periodic cleanups
Limit shutdown retries to exit
Prevent queries ending with to match all

Fixed

Fix scripts in strict mode

0.32.0 - 2019-08-05

Fixed

Using stemmer during queries

0.31.0 - 2019-08-01

Changed

No longer logging replication operations by default (it now requires --log replicas)

Fixed

Uncommon race condition while destroying clients
Replicas no longer send db updated messages
Always replicate databases from primary

0.30.0 - 2019-07-30

Changed

Adds default operator for queries parsed with the boolean parser

Fixed

Discovery protocol callback executed by appropriate thread
Fixes race condition during shutdown

0.29.0 - 2019-07-25

Changed

BREAKING: Foreign schemas no longer accept selectors
BREAKING: Global string fields indexed as text datatype
QueryDSL using _and or _or also enable booleans

Fixed

Fix foreign schemas URIs
Fixes issue #19
Fixes issue #20

0.28.0 - 2019-07-24

Changed

BREAKING: UPDATE method no longer receives upsert query param
BREAKING: Added UPSERT method
BREAKING: Removed MERGE and STORE methods
Restore always commits at the end

Fixed

Restoring of documents in a clustered index
Commit in databases with remote shards (remote wasn’t receiving the commit)
Better handling of database flags (when changed)
Uncompressed UUIDs representation was buggy

0.27.0 - 2019-07-17

Changed

BREAKING: UPDATE and PATCH don’t create new objects, object must exist (or use upsert query param)
BREAKING: STORE removed (use PUT or UPDATE)
Updated xapian-core to latest 1.5 (git@00f69cf3928b44a756ddafcde248610f72babf62)

Fixed

Schemas not saving default schema as metadata some times
Remote protocol matcher, for remote queries, now holds list for all pending queries

0.26.0 - 2019-07-12

Changed

BREAKING: Errors returned with status and message (no hash #)

Fixed

Fixed _meta producing errors when passed to POST, PUT or UPDATE

0.25.0 - 2019-07-11

Added

Added support for _meta inside schemas (to allow user to add custom meta data associated with it)

Changed

BREAKING: Schema declaration no longer needs nested _schema -> schema node; it now only needs _schama
BREAKING: Strict mode requires newly created indexes to declare _settings with at least number_of_shards and number_of_replicas.
BREAKING: Foreign schemas no longer use _endpoint, it was renamed to _foreign.

Fixed

Aggregations (min/max) which have no elements could result in errors.
Fix parser query params to qdsl for not operator

0.24.0 - 2019-07-10

Changed

BREAKING: Clustering: Added primary shard promotions
Updated xapian-core to latest 1.5 (git@db790e9e12bb9b3ebeaf916ac0acdea9a7ab0dd1)
Python client updated
Quarantine (invalid) WAL and database files/directories when appropriate
Only nodes marked as primary for shards get the replica, others simply erase (or quarantine) stalled databases.
Unused server sockets are now fully closed during shutdown

Fixed

BREAKING: Clustering: Increased overall cluster stability
Remote protocol: Race conditions for some used database objects after checkin
Refactored node shutdown process
Schemas LRU properly detect changes to schemas now checking only inside “schema” and “description”
WAL had a bug which could lead to skipped slots (it now checks revision before writing lines and recovers after errors)
Many solo mode (and CLUSTERING=off) fixes.

0.23.0 - 2019-05-24

Changed

BREAKING: Geo: Renamed height to altitude
BREAKING: Geo: Renamed lng to lon

Fixed

Schema with nested arrays and objects

0.22.2 - 2019-05-16

Added

Support for ‘float’ as an alternative name to ‘floating’ datatype

Fixed

Undefined behavior in UUID, serializer and term generator
Error when requesting invalid types

0.22.1 - 2019-05-16

Changed

Performance improvements with restore by launching parallel DocIndexers
Queries using glob wildcards

Fixed

Nested arrays and objects in arrays
Restoring for GCC compiled Xapiand

0.22.0 - 2019-05-10

Changed

BREAKING: Added _version to document data
BREAKING: Non-hashed prefixes for fields
Indexing optimizations (_id and _version values)
RESTORE now doesn’t check _version

Fixed

Concurrency issues
Issues with document version checks
Fuzzy Queries fixed

0.21.2 - 2019-05-06

Changed

Enabled Honey backend

Fixed

Issues when launching multiple nodes simultaneously
Retry database initialization during node launch

0.21.1 - 2019-05-05

Fixed

Fix compiler warning about DropAction/GetAction “changing meaning”

0.21.0 - 2019-05-04

Changed

Default do check_at_least one when using aggregations
Updated xapian-core, fixes issues with leaking sockets
BREAKING: Added patches for xapian-core to handle parallelized queries

Fixed

Fix issues when starting servers simultaneously

0.20.1 - 2019-04-29

Fixed

Fix issue with aggregations returning invalid results at times

0.20.0 - 2019-04-27

Fixed

BREAKING: Remote Protocol issue which provoked messaged to get out of sync
Issues schemas not being saved (unexpected “_id” errors)
Detection of remote schema updates
Certain cluster remote queries

0.19.7 - 2019-04-15

Added

Experimental parsing of YAML
Postman collection for testing documentation requests

Changed

Require CMake 3.12 (again)
Docker image using Alpine 3.9, GCC 8 and ICU

Fixed

Check for requests with invalid body
Compilation with cluster disabled

0.19.6 - 2019-04-13

Fixed

Casts

0.19.5 - 2019-04-13

Fixed

Throttling of commits (exception was being thrown)

0.19.4 - 2019-04-13

Fixed

Compilation using cmake 3.5 (use static libraries instead of object libraries)
Regression which slowed down bulk indexing

0.19.3 - 2019-04-12

Added

GCC 7 and GCC 8 support (and libstdc++)

Changed

Refactored pfh module
Using ENUM() with minimal perfect hash functions (improves performance)
Upgraded xapian-core to latest 1.5 (git@84ccecdfb8938b4011aac0bf9539c139204acd22)

0.19.2 - 2019-04-09

Changed

Colorized INFO
Tracebacks with normalized address
Require CMake 3.12

Fixed

Use nanosleep instead of usleep and libev checking for EINTR
Fix warning about available files under OS X

0.19.1 - 2019-04-08

Added

Added CJK NGRAM and CJK words as parameters to ‘text’ datatype
Enable fuzzy searches in queries: use '~~'. E.g. “unserten~~3” would expand to “uncertain”

Changed

Ignore XAPIAN_* environment variables
INFO signal showing busy threads callstacks, when tracebacks are enabled
All exceptions now contain tracebacks, when tracebacks are enabled
Hash for resolving cluster node for indexes skipping slashes

Fixed

Fix ranges in query
Fix restoring from an empty request
Formatting applied to saved dates

0.19.0 - 2019-04-05

Changed

BREAKING: Remove support for \xHH in json

Fixed

Fixed errors during heavy writes/reads
Fixed race condition in restore indexer

0.18.1 - 2019-04-02

Fixed

Fixed logging for verbose request/responses

0.18.0 - 2019-04-01

Added

The ?echo query param returns the new/updated object

Changed

BREAKING: By default, write/update operations no longer return the object (see ?echo)
BREAKING: Removed :schema, schemas are now added/edited by using the Create Index API.
Verbosity level 4 or higher (-vvvv) turns on --echo, --pretty and --comments

Fixed

Replication protocol now properly closing connections on errors

0.17.0 - 2019-03-28

Added

Set metadata
Added PUT index

Changed

BREAKING: Removed :touch

Fixed

HTTP Mappings
Schemas

0.16.1 - 2019-03-26

Fixed

Selectors were not working
Mime Types

0.16.0 - 2019-03-26

Added

Added —pretty (and —no-pretty) options (for default ?pretty)
Verbosity also toggles “prettiness”
HTTP method mapping + override
TravisCI builds, thanks to Vitold S. (@vit1251)

Fixed

Fixed _version checks

0.15.0 - 2019-03-21

Added

Sharding support added
- By default there are now five shards per index
- Shards are put inside subdirectories with the shard number prefixed with .__

Changed

BREAKING: All schemas are now foreign by default, and get put inside the databases indexes
BREAKING: Databases indexes directories work like shards and thus were renamed from .xapiand/<node_name> to .xapiand/index/.__<node_idx>

0.14.0 - 2019-03-12

Changed

BREAKING: Cluster directory renamed from .cluster to .xapiand;
BREAKING: Indexes directories renamed from .index/<node_idx> to .xapiand/<node_name>
BREAKING: Upgraded xapian-core to latest 1.5 (master)

0.12.2 - 2019-03-11

Fixed

Fix regression introduced in 0.12.1 during cluster bootstrapping

0.12.1 - 2019-03-11

Fixed

Fix requests resulting in Bad Gateway with stalled endpoints

Changed

Renamed options for logging from --log-* to --log <setting>

0.12.0 - 2019-03-10

Fixed

Aggregations with _aggs in different order
JSON serialization of Infinite and NaN
Fixed race condition during bulk indexing

Changed

BREAKING: Fields in responses renamed and nested differently: + query.hits moved to hits + query.matches_estimated renamed to count + query.total_count renamed to doc_count
MERGE method is deprecated and will be removed, use UPDATE instead
Default UUID mode is now encoded + compact

0.11.1 - 2019-03-06

Fixed

Fix Docker build

Added

Added support to routing key hints in the API, by using routing query param

0.11.0 - 2019-03-05

Fixed

Cluster replication is now functional, it was broken in 0.10.0
Fix searching in “_id” field
Fixed and documented Scripts and Foreign Scripts

Changed

BREAKING: .index shared by node
BREAKING: Keyword datatype term prefix is now ‘K’
BREAKING: Guessed IDs are now strings also for numeric IDs
BREAKING: URL drill selector now uses dot (’.’) directly, so document IDs cannot have dots in them now.
BREAKING: System-added fields in returned objects are no longer prefixed by ’#’
Never overwrite an existent database
Index only adds new indexes during write operations
Do not save empty data inside database
Numeric IDs are auto-incremented when creating new documents with POST

Added

Added ’*” for using as multiple indexes

0.10.2 - 2019-02-20

Fixed

Docker build had missing symbols since 0.10.0
Fix exit code on errors

0.10.1 - 2019-02-20

Fixed

Default database path is /var/run/xapiand

0.10.0 - 2019-02-20

Added

Added _match_all and _match_none to :search command
Added the Elite Set Operator

Changed

BREAKING: Cluster using .index and .cluster databases
BREAKING: Indexes paths (endpoints) no longer have a trailing slash
Use OP_FILTER for terms in range queries
Flattened range queries
The default stopper during indexation is now stop_stemmed
Numeric ranges are now properly calculating the filtering terms
Geospatial queries are now calculating better the filtering trixels terms
Default accuracies changed
Removed _raw from QueryDSL

Fixed

Fixed sort query param during search

0.9.0 - 2019-02-11

Added

Embedded Xapian core 1.5.0 in the source code
Accept application/x-ndjson as input for :restore command
Home and docs site with cosmetic improvements

Changed

Greatly improves performance
Documentation extended
Upgraded to fmtlib v5.3.1 library
Upgraded to ChaiScript v6.1.1 library
Sort accepting casts
QueryDSL with flattened queries

Fixed

Fixes a few issues with the way geospatial locations were being filtered and indexed

0.8.15 - 2019-02-01

Added

Keep-Alive and Close connection support

Changed

Compress documents using LZ4 instead of gzip
Text fields no longer remove terms with Stopper

Fixed

Fix bug with UUIDs and macOS

0.8.14 - 2019-01-27

Added

Added new Xapiand client (based on Elasticsearch client)
Added sorting for Aggregations
Added _keyed to aggregations optional. Keyed are off by default now
Added _shift to aggregations

Deprecated

Schema deprecated string type, it now only has text and keyword (string will be removed at some point)

0.8.13 - 2019-01-21

Added

Added bounds to standard deviation aggregation
Documentation about Aggregations

Changed

Remote and Replication protocol are now split in two

Fixed

Range keys for aggregations fixed

0.8.12 - 2019-01-15

Changed

Documentation updated

Fixed

Fix Docker entrypoint

0.8.11 - 2019-01-14

Changed

Uses /var/db/xapiand directory for database by default

0.8.10 - 2019-01-10

Changed

Default bind address is now again 0.0.0.0

0.8.9 - 2019-01-10

Fixed

Fixes to multicast script for Kubernetes

0.8.8 - 2018-12-27

Added

Added daemon script for multicasting across k8s nodes

Changed

UDP usage tweaked (for Discovery)
Default TCP bind address is now the current IP

0.8.7 - 2018-12-21

Fixed

Explicit initialization of schema for cluster database
Cluster database endpoints normalized

0.8.6 - 2018-12-20

Changed

Using fnv1ah64 for clustering hash (jump_consistent_hash)

0.8.5 - 2018-12-20

Changed

Logo adjustments + banner updated

0.8.4 - 2018-12-16

Fixed

Fix Remote storage
Discovery protocol fixed issues with cluster

0.8.3 - 2018-12-19

Changed

Discovery/Raft: Merged both into Discovery

Fixed

Colorize all node names
Fix exit codes

0.8.2 - 2018-12-16

Changed

Improve efficiency of nodes update after PING

0.8.1 - 2018-12-13

Changed

Rewrite of Database Pool
Thread names changed

0.8.0 - 2018-11-21

Added

Cluster mode enabled
Adds replication and remote protocol

0.7.0 - 2018-09-21

Added

Prometheus metrics exposed at /:metrics

0.6.2 - 2018-05-03

Added

Added --flush-threshold command line option

Changed

MERGE and PATCH now require the document already exists
Renamed command line option --force-up to simply --force

Fixed

Fix restore command memory usage
Fix HTTP protocol on malformed messages
Fix HTTP returning of large object bodies
Fix indexing documents with integer IDs
Fix io::read() to always return requested size when available
Fix date accuracies

0.6.1 - 2018-04-25

Added

Parallel restore commands
General optimizations

Changed

BREAKING: Geospatial fields changed generated terms. Reindexing needed!

Fixed

Fixed geospatial terms and accuracy
Fixes storage (no longer returns 500)
Fixes multithreading bug with collected statistics

0.6.0 - 2018-04-11

Added

Added :dump and :restore endpoints
Added time it took (in milliseconds) to execute a :search query
Added sort, limit and offset to query DSL
Python: Xapiand client updated

Changed

BREAKING: Support for multi-content (by Content-Type) documents
Using C++17
Updated FreeBSD port

Fixed

GCC 7 compatibility
Fixes problem with big body responses breaking the logs
Towards MultiarchSpec compatibility for Linux

0.5.2 - 2018-04-02

Changed

Logo updated

Fixed

Fixes issues while compiling with GCC + cleanups

0.5.1 - 2018-03-28

Added

A Homebrew tap was created

Changed

Versioning of the project is now officially in the “0.x” line, after going through many ghost versions.
Documentation was updated

0.5.0 - 2018-03-23

Added

Site is up and running
Documentation is finally cooking in the oven.
This release also features a new website (based on Jekyll’s theme)

0.4.2 - 2018-02-16

Fixed

Fixes issues with “already locked database”

0.4.1 - 2017-10-02

Changed

First stable release
Lots of optimizations

0.4.0 - 2016-11-14

Fixed

Fixed a few issues

0.3.0 - 2016-06-08

Added

First beta release

Fixed

Working under FreeBSD

0.0.0 - 2015-02-20

Birthday!