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 Project overview and navigation by audience
2 Installation Package install, source build, local docs, GitHub Pages deployment
3 Quick Start First database, table, inserts, SQL, and DataFrame conversion
4 Core Concepts Databases, tables, schemas, results, durability, and interfaces
5 Python Client Guide Application-oriented Python workflows
6 SQL Guide DDL, DML, analytics, transactions, table functions, search
7 Data Import Records, batches, DataFrames, files, and temporary tables
8 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
Performance Users comparing ApexBase against SQLite, DuckDB, and vector workloads
Usage Examples Users looking for task-oriented snippets
Full-Text Search Guide Users building text search workflows
Float16 Vector Guide Users storing and querying embeddings
Storage Architecture Contributors and maintainers
Engineering Guidelines Contributors changing query or storage paths
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

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

  • Pull requests run python -m mkdocs build --strict.
  • Pushes to main 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).