Documentation
Each package ships its own documentation site, versioned and deployed from its repository. This page is the hub — start with the stable Python stack.
Python — stable
-
pycubrid
Connection strings, type mapping, CAS wire protocol reference, complete API reference.
-
sqlalchemy-cubrid
Dialect setup, schema reflection, MERGE/ENUM behavior, Alembic migrations.
-
cubrid-cookbook-python
75 runnable examples, 7 production templates, nightly golden-test pipeline.
-
cubrid-mcp-server
12 MCP tools, read-only safety whitelist, domain knowledge packs, expert prompts.
Rust / Go / TypeScript — in progress
Documentation sites for these stacks are not yet published. Track progress in the package catalog:
- Rust packages — cubrid-rs workspace, sea-orm-cubrid
- Go packages — cubrid-go, gorm-cubrid
- TypeScript packages — cubrid-client, drizzle-cubrid
Documentation conventions
- Every repository deploys its docs with the same MkDocs Material pipeline
(
mkdocs build --strict→ GitHub Pages). - Docs are bilingual where it matters most: English canonical content with Korean translations maintained in-repo.
- API references are generated from type-annotated sources — if the docs and the code disagree, the code wins; please open an issue.