CUBRID Engine API Reference¶
Auto-generated source-level documentation for the
CUBRID database engine
(develop branch).
This site is rebuilt weekly from the latest CUBRID source by a GitHub Actions workflow.
How to use this site¶
- Files — browse documentation by source file path under API Reference → Files.
- Classes — navigate the C++ class hierarchy from Classes.
- Namespaces — jump into
cubrid::*and other namespaces from Namespaces. - Modules — logical groupings (
@defgroup) from Modules. - Search — use the search box at the top right (instant, client-side, fuzzy-matched).
What is documented¶
The reference covers the CUBRID server engine source tree
(cubrid/src/) excluding the client interface drivers
(cci, jdbc, odbc, oledb) and the management/admin tools
(cm_common, tools, win_tools).
| Item | Setting |
|---|---|
| Upstream repository | CUBRID/cubrid |
| Branch tracked | develop |
| Rebuild cadence | Weekly (Sundays UTC) + manual trigger |
| Generator | Doxygen → MkDocs Material via mkdoxy |
Build diagnostics¶
Doxygen warnings from the most recent build are recorded at Build Info → Doxygen Warnings.
Reporting documentation issues¶
If a symbol is missing, mis-rendered, or links to the wrong place, open an issue on the cubrid-doxygen repository. For issues in the underlying source comments, open an issue on CUBRID/cubrid instead.