Skip to content

ApexBase Documentation Index

This directory is the source for the ApexBase documentation site. The site is built with MkDocs Material from the repository root:

python -m pip install -r docs/requirements.txt
python -m mkdocs serve
Step Page What you get
1 Home Product overview and navigation by audience
2 What's New in 2.0 V5 GA features, compatibility rules, migration, known limits
3 Installation Package install, source build, local docs
4 Quickstart Agent memory, analytics SQL, in-memory mode, durability
5 Core Concepts Databases, tables, schemas, types, durability, execution model
6 Agent Memory & RAG Tool-calling memory store with hybrid retrieval
7 Python Client Application-oriented Python workflows
8 SQL Guide DDL, DML, analytics, transactions, table functions, search
9 Data Import Records, batches, DataFrames, files, temporary tables
10 Server Protocols PostgreSQL Wire and Arrow Flight

Reference and deep dives

Page Audience
Python API Reference Python users who need exact method signatures
Rust Embedded API Rust users embedding ApexBase directly
Usage Examples Task-oriented snippets for every major workflow
Performance Reproducible SQLite/DuckDB/vector benchmark snapshot
Full-Text Search Guide BM25 search, MATCH(), fuzzy search, hybrid retrieval
Float16 Vector Guide Storing and querying embeddings in half precision
Vector Quantization Guide Compressed candidates with exact reranking
Storage Architecture Contributors and maintainers
Scan & Physical Execution Contributors extending filters, grouping, ordering, or scan scheduling
Read-Path Capabilities Contributors touching read visibility, merged reads, or scan fallbacks
Resource Ownership Contributors changing caches, session state, or memory limits
Fused Filter + GROUP BY Design Contributors working on the filtered-grouped execution kernel
Engineering Guidelines Contributors changing query or storage paths
Query Optimizer Roadmap Contributors tracking planner work
HTAP Roadmap High-level project direction

Server quick reference

CLI Default Description
apexbase-serve pg=5432, flight=50051 Start both servers simultaneously
apexbase-server 5432 PostgreSQL Wire only
apexbase-flight 50051 Arrow Flight gRPC only

Documentation deployment

Build and validate the site locally before opening a pull request:

python -m pip install -r docs/requirements.txt
python -m mkdocs build --strict
python -m mkdocs serve

GitHub Pages deployment is handled by .github/workflows/docs.yml.

  • Pull requests run python -m mkdocs build --strict; the strict flag fails the build on missing link targets and broken navigation entries.
  • Manual workflow_dispatch runs deploy the current package version with the latest alias.
  • v* tags deploy the tag version and keep historical documentation available.
  • The site URL is configured as https://birchkwok.github.io/apexbase/.

In GitHub repository settings, use Pages → Build and deployment → Source → Deploy from a branch, with branch gh-pages and folder /(root).