latentprion/cppbessot
1
0
Fork 0
mirror of https://github.com/latentPrion/cppbessot.git synced 2026-04-17 18:44:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Change "DB version" language to "DB dir" language

Browse Source
This commit is contained in:
Hayodea Hekol
2026-03-02 21:57:09 -04:00
parent 346cc75ba9
commit 0b34a5690c
9 changed files with 131 additions and 125 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@@ -16,6 +16,11 @@ The primary schema root folder is configurable via:
- `CPPBESSOT_WORKDIR` (defaults to `db`)
This repo also carries self-contained schema fixtures for test runs:
- `db/test-schema-v1.1`
- `db/test-schema-v1.2`
## Simple Integration Guide
### 1) Add the module from your parent project
@@ -25,15 +30,15 @@ The primary schema root folder is configurable via:
cmake_minimum_required(VERSION 3.16)
project(MyApp LANGUAGES CXX)
# Optional: where schema versions live (default is "db")
# Optional: where schema directories live (default is "db")
set(CPPBESSOT_WORKDIR "db")
# Required for generation/library selection
set(DB_SCHEMA_VERSION_TO_GENERATE "v1.1")
# Required: exact schema directory basename under CPPBESSOT_WORKDIR
set(DB_SCHEMA_DIR_TO_GENERATE "v1.1")
# Optional: only needed if you will run db_gen_migrations
# set(DB_SCHEMA_MIGRATION_VERSION_FROM "v1.1")
# set(DB_SCHEMA_MIGRATION_VERSION_TO "v1.2")
# set(DB_SCHEMA_DIR_MIGRATION_FROM "v1.1")
# set(DB_SCHEMA_DIR_MIGRATION_TO "v1.2")
include(path/to/cppbessot/cmake/CppBeSSOT.cmake)
```
@@ -51,11 +56,24 @@ Optional migration generation:
```bash
cmake -S . -B build \
-DDB_SCHEMA_MIGRATION_VERSION_FROM=v1.1 \
-DDB_SCHEMA_MIGRATION_VERSION_TO=v1.2
-DDB_SCHEMA_DIR_MIGRATION_FROM=v1.1 \
-DDB_SCHEMA_DIR_MIGRATION_TO=v1.2
cmake --build build --target db_gen_migrations
```
### 2b) Build the bundled serdes tests
These tests validate that checked-in generated C++ model code can be compiled and used for JSON round trips. They are owned by `cppbessot`, not by any parent project.
```bash
git submodule update --init --recursive tests/googletest
cmake -S . -B build-tests -DDB_SCHEMA_DIR_TO_GENERATE=test-schema-v1.2
cmake --build build-tests --target cpp_serdes_test_schema_v1_2
ctest --test-dir build-tests --output-on-failure
```
The local test fixtures live under `db/test-schema-v1.1` and `db/test-schema-v1.2`. They intentionally differ so migration generation has real additive schema changes to process.
### 3) Link generated libraries
```cmake