Dependencies
Edit pageXapiand is assembled from 57 standalone Kronuz libraries and 8 third-party
ones, all fetched at CMake configure time through FetchContent, each pinned
to an exact commit or release. Most of the Kronuz libraries were cut out of
Xapiand’s own tree, so each one is small, focused and tested on its own; the
search engine, strata and
prospect, is two of them. Because they are
fetched, the first configure needs a network connection (see
Building from Sources).
This page lists them by role, with a link to each repository, and shows how the composite ones depend on each other.
Transitive dependency tree
Section titled “Transitive dependency tree”Most libraries are leaves that Xapiand consumes directly. A few are composite: they fetch their own dependencies at their own pins, which is where the tree gets its depth.
Xapiand├── prospect ──── strata, analysis, docset*, bitpack*, fst*├── strata ────── task, threadpool, compressors, hashes, journal*, completion*,│ termdict*, fst*, fusefilter*, residency*, varint*, crc32c*├── queryparser ─ analysis├── analysis ──── snowball, unicode├── http ──────── reactor, task, http-parser, compressors, radix-router*, asio├── reactor ───── task, asio├── task ──────── asio├── msgpack ───── atomic-shared-ptr, constexpr-phf, enum-reflection, hashes,│ located-exception, repr, strict-stox, RapidJSON├── storage ───── compressors, errno-names, strict-stox, stringified├── logger ────── scheduler, term-color├── scheduler ─── threadpool, random, stash*├── base-x ────── uinteger_t*└── 40-odd leaf libraries, consumed directly (the tables below)
* fetched only by the library to its left, at that library's pinThe engine
Section titled “The engine”| Library | Purpose |
|---|---|
| strata | Segment store: one index per shard, its write buffer, segments, manifests, commits, merges, and the catalog of open indexes |
| prospect | The search layout on strata: postings, positions, doc values, BM25 scoring, top-k, sorting, collapse |
| task | C++20 coroutine tasks: executor affinity, time-slice budgets, cancellation, async mutexes and events |
| analysis | Text analysis: words, case folding, stems, stop words, CJK n-grams, positions |
| snowball | The Snowball stemmers, all 38 algorithms |
| unicode | Unicode categories, lowercase mappings and UTF-8 decoding |
| queryparser | The query-string grammar of text fields, analysed like the index terms |
| boolean-parser | The boolean q= query language (AND, OR, NOT, XOR, MAYBE) |
Runtime and storage
Section titled “Runtime and storage”| Library | Purpose |
|---|---|
| threadpool | WorkPool and WorkGroup: the pool of named threads that runs chores and merges |
| scheduler | Timer-wheel scheduler and debouncer |
| storage | Crash-safe append-only volumes (32 GiB each) for the WAL and the blobs |
| io | POSIX file and socket I/O (EINTR-safe, portable) |
| fs | Filesystem utilities (stat, mkdir, walk) |
| system | OS facts: descriptor limits, CPU count, memory |
Network and HTTP
Section titled “Network and HTTP”| Library | Purpose |
|---|---|
| reactor | Asio server runtime: shared-nothing loops, admission, TLS, lag probes, phased teardown |
| http | HTTP/1.1 on reactor: routing, compression, ranges, body streams |
| http-parser | HTTP parser that accepts Xapiand’s custom verbs |
| http-log | Colored request and response logs |
| url-parser | URL paths (index, id, selector, :command) and query parameters |
Serialization, identity and time
Section titled “Serialization, identity and time”| Library | Purpose |
|---|---|
| msgpack | The copy-on-write MsgPack value, JSON adaptors, JSON Patch |
| cuuid | UUID generation, parsing and the condensed binary form |
| datetime | Date and time parsing and formatting |
| epoch | Unix time as an integer in any unit |
| endian | Endian detection and swapping |
| base-x | Base-N encodings (Base32, Base58, …) |
| strict-stox | Strict string-to-number conversion |
Geography and text metrics
Section titled “Geography and text metrics”| Library | Purpose |
|---|---|
| htm | Hierarchical Triangular Mesh: shapes on the sphere as integer ranges |
| cartesian | Cartesian coordinate math |
| soundex | Soundex phonetic encoding (EN, FR, DE, ES) |
| double-metaphone | Double Metaphone phonetic encoding |
| string-similarity | Levenshtein, Jaro-Winkler, Jaccard, Sørensen-Dice, LCS |
Logging and diagnostics
Section titled “Logging and diagnostics”| Library | Purpose |
|---|---|
| logger | Structured logging with categories and lazy arguments |
| traceback | Crash backtraces and signal handling |
| errno-names | errno to name mapping |
| located-exception | Source location in exceptions |
| term-color | ANSI terminal colors |
Hashing, randomness and compression
Section titled “Hashing, randomness and compression”| Library | Purpose |
|---|---|
| hashes | Non-cryptographic hashes (FNV-1a, xxHash, …) |
| md5 | MD5 |
| sha256 | SHA-256 |
| random | Random helpers over one per-thread generator |
| compressors | LZ4, zstd and deflate codecs |
Strings
Section titled “Strings”| Library | Purpose |
|---|---|
| strings | String utilities (split, trim, format) |
| split | Lazy string splitting |
| repr | Readable representation of values |
| stringified | One parameter type for any string, with a c_str() when a C API needs one |
| char-classify | Character classification tables |
| static-string | Compile-time strings |
Compile-time and small utilities
Section titled “Compile-time and small utilities”| Library | Purpose |
|---|---|
| constexpr-phf | Compile-time minimal perfect hash for keyword dispatch |
| enum-reflection | Enum names and lookups |
| utype | toUType (an enum to its underlying type) |
| iterators | Lazy transform, chain and reversed adaptors |
| atomic-shared-ptr | Atomic shared_ptr |
| allocators | STL allocators, a node pool, byte-budgeted resources, heap tracking |
| lru-cache | LRU cache with time-to-live |
| math | Integer helpers: non-negative modulo, saturating add and subtract |
| nanosleep | Portable nanosleep |
| namegen | Fantasy name generator (the node’s default name) |
Third-party libraries
Section titled “Third-party libraries”These come from outside the Kronuz libraries, also through FetchContent.
| Library | Version | Purpose |
|---|---|---|
| Asio | 1.36.0 | Networking and the event loops, standalone (no Boost) |
| CLI11 | 2.4.2 | Command-line option parsing |
| cppcodec | 0.2 | Base-N codecs |
| LZ4 | 1.8.1 | LZ4 compression |
| prometheus-cpp | 1.2.4 | The /:metrics exposition (core only) |
| RapidJSON | a pinned commit | JSON parsing and writing |
| libyaml | 0.2.5 | YAML bodies |
| Lua | 5.4.7 | Document scripts, through the C API, with a patch that meters their work |
The system provides the rest: zstd, libuuid, zlib, the threads library and, with HTTPS on (the default), OpenSSL 3.