Skip to content

Dependencies

Edit page

Xapiand 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.

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 pin
LibraryPurpose
strataSegment store: one index per shard, its write buffer, segments, manifests, commits, merges, and the catalog of open indexes
prospectThe search layout on strata: postings, positions, doc values, BM25 scoring, top-k, sorting, collapse
taskC++20 coroutine tasks: executor affinity, time-slice budgets, cancellation, async mutexes and events
analysisText analysis: words, case folding, stems, stop words, CJK n-grams, positions
snowballThe Snowball stemmers, all 38 algorithms
unicodeUnicode categories, lowercase mappings and UTF-8 decoding
queryparserThe query-string grammar of text fields, analysed like the index terms
boolean-parserThe boolean q= query language (AND, OR, NOT, XOR, MAYBE)
LibraryPurpose
threadpoolWorkPool and WorkGroup: the pool of named threads that runs chores and merges
schedulerTimer-wheel scheduler and debouncer
storageCrash-safe append-only volumes (32 GiB each) for the WAL and the blobs
ioPOSIX file and socket I/O (EINTR-safe, portable)
fsFilesystem utilities (stat, mkdir, walk)
systemOS facts: descriptor limits, CPU count, memory
LibraryPurpose
reactorAsio server runtime: shared-nothing loops, admission, TLS, lag probes, phased teardown
httpHTTP/1.1 on reactor: routing, compression, ranges, body streams
http-parserHTTP parser that accepts Xapiand’s custom verbs
http-logColored request and response logs
url-parserURL paths (index, id, selector, :command) and query parameters
LibraryPurpose
msgpackThe copy-on-write MsgPack value, JSON adaptors, JSON Patch
cuuidUUID generation, parsing and the condensed binary form
datetimeDate and time parsing and formatting
epochUnix time as an integer in any unit
endianEndian detection and swapping
base-xBase-N encodings (Base32, Base58, …)
strict-stoxStrict string-to-number conversion
LibraryPurpose
htmHierarchical Triangular Mesh: shapes on the sphere as integer ranges
cartesianCartesian coordinate math
soundexSoundex phonetic encoding (EN, FR, DE, ES)
double-metaphoneDouble Metaphone phonetic encoding
string-similarityLevenshtein, Jaro-Winkler, Jaccard, Sørensen-Dice, LCS
LibraryPurpose
loggerStructured logging with categories and lazy arguments
tracebackCrash backtraces and signal handling
errno-nameserrno to name mapping
located-exceptionSource location in exceptions
term-colorANSI terminal colors
LibraryPurpose
hashesNon-cryptographic hashes (FNV-1a, xxHash, …)
md5MD5
sha256SHA-256
randomRandom helpers over one per-thread generator
compressorsLZ4, zstd and deflate codecs
LibraryPurpose
stringsString utilities (split, trim, format)
splitLazy string splitting
reprReadable representation of values
stringifiedOne parameter type for any string, with a c_str() when a C API needs one
char-classifyCharacter classification tables
static-stringCompile-time strings
LibraryPurpose
constexpr-phfCompile-time minimal perfect hash for keyword dispatch
enum-reflectionEnum names and lookups
utypetoUType (an enum to its underlying type)
iteratorsLazy transform, chain and reversed adaptors
atomic-shared-ptrAtomic shared_ptr
allocatorsSTL allocators, a node pool, byte-budgeted resources, heap tracking
lru-cacheLRU cache with time-to-live
mathInteger helpers: non-negative modulo, saturating add and subtract
nanosleepPortable nanosleep
namegenFantasy name generator (the node’s default name)

These come from outside the Kronuz libraries, also through FetchContent.

LibraryVersionPurpose
Asio1.36.0Networking and the event loops, standalone (no Boost)
CLI112.4.2Command-line option parsing
cppcodec0.2Base-N codecs
LZ41.8.1LZ4 compression
prometheus-cpp1.2.4The /:metrics exposition (core only)
RapidJSONa pinned commitJSON parsing and writing
libyaml0.2.5YAML bodies
Lua5.4.7Document 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.