apexbase 1.22.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
98
99
100
101
102
103
104
105
106
107
108
109
110
111

site_name: ApexBase
site_author: Birch Kwok
site_description: High-performance HTAP embedded database with Rust core and Python API
site_url: https://birchkwok.github.io/ApexBase/
repo_url: https://github.com/BirchKwok/ApexBase
repo_name: birchkwok/ApexBase
edit_uri: edit/main/docs/

strict: true
exclude_docs: |
  README.md
  requirements.txt
  hooks/*.py

hooks:
  - hooks/mkdocs_version.py

theme:
  name: material
  language: en
  logo: img/logo.svg
  favicon: img/favicon.svg
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.top
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.path
    - toc.integrate
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - content.tabs.link
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  font:
    text: false
    code: Roboto Mono

extra:
  paths:
    - apexbase/python
  version:
    provider: mike
    default: latest

plugins:
  - search

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
      permalink_class: headerlink
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

nav:
  - Home: index.md
  - Getting Started:
      - Installation: installation.md
      - Quick Start: QUICK_START.md
      - Core Concepts: concepts.md
  - User Guide:
      - Python Client: user-guide/python-client.md
      - SQL Guide: user-guide/sql.md
      - Data Import: user-guide/data-import.md
      - Server Protocols: user-guide/server-protocols.md
      - Examples: EXAMPLES.md
  - Reference:
      - Python API: API_REFERENCE.md
      - Rust Embedded API: RUST_EMBEDDED_API.md
  - Performance: performance.md
  - Features:
      - Full-Text Search: FTS_GUIDE.md
      - Float16 Vectors: FLOAT16_VECTOR_GUIDE.md
  - Internals:
      - Storage Architecture: STORAGE_ARCHITECTURE.md
      - Engineering Guidelines: ENGINEERING_GUIDELINES.md
      - HTAP Roadmap: HTAP_ROADMAP.md
  - Release Notes: release-notes.md
  - Docs Index: documentation-index.md