apexbase 1.19.0

High-performance HTAP embedded database with Rust core
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

# Installation

This page covers the common ways to install ApexBase and work on the documentation site.

## Requirements

| Component | Requirement |
| --- | --- |
| Python | 3.9 or newer |
| Operating systems | Linux, macOS, Windows |
| Architectures | x86_64, ARM64 |
| Source builds | Rust toolchain, `maturin`, and `protobuf` tooling for server features |

## Install From PyPI

```bash
python -m pip install apexbase
```

Check that the package imports:

```bash
python - <<'PY'
from apexbase import ApexClient

with ApexClient("./apexbase_smoke") as client:
    client.create_table("smoke")
    client.store({"ok": True})
    print(client.execute("SELECT COUNT(*) AS rows FROM smoke").to_dict())
PY
```

## Build From Source

```bash
git clone https://github.com/BirchKwok/ApexBase.git
cd ApexBase
python -m pip install maturin
maturin develop --release
```

For a development environment with test tools:

```bash
python -m pip install -e ".[dev]"
maturin develop --release
python -m pytest test/ -q
```

## Install Documentation Tools

The documentation site is built with MkDocs Material.

```bash
python -m pip install -r docs/requirements.txt
python -m mkdocs serve
```

Open the local URL printed by MkDocs. To verify the production build:

```bash
python -m mkdocs build --strict
```

## GitHub Pages Deployment

The repository includes `.github/workflows/docs.yml`. It uses `mike` so users can switch between historical documentation versions from the header.

- Builds the MkDocs Material site on pull requests.
- Deploys `pyproject.toml`'s current version on pushes to `main`.
- Deploys the tag version on `v*` tags.
- Updates the `latest` alias and keeps older version directories on the `gh-pages` branch.

In the GitHub repository settings, set **Pages -> Build and deployment -> Source** to **Deploy from a branch**, then choose **`gh-pages`** and **`/(root)`**. After the next successful deployment, the site is published at:

```text
https://birchkwok.github.io/ApexBase/
```

For local versioned preview, use `mike` after installing the documentation requirements:

```bash
mike deploy 1.19.0 latest
mike serve
```

## Upgrade

```bash
python -m pip install --upgrade apexbase
```

When developing from source, rebuild the extension after Rust or Python binding changes:

```bash
maturin develop --release
```