Generic DDL schema-version helpers (per MySQL schema / version table).
Each schema defines its SchemaVersion table from SchemaVersionTable,
which records the code's version in the same step that creates the table. The
helpers below check an existing database against the installed code, e.g.::
from scene_pipelines.core.versioning import ensure_schema_version
from scene_pipelines.schemas.scene._schema import (
SCENE_SCHEMA_VERSION,
SchemaVersion,
)
ensure_schema_version(SCENE_SCHEMA_VERSION, SchemaVersion)
Bases: RuntimeError
DB schema definition version does not match installed code.
dataclass
Comparison of installed code vs the latest version row in the DB.
Bases: Manual
Base for a schema's SchemaVersion table (subclass it; do not decorate this).
Creating the table records code_version right away, so a database never
exists without its version. Append a row when a migration has been applied;
the latest applied_at row is the current version.
Attributes:
| Name | Type | Description |
|---|---|---|
code_version |
str
|
Schema version of the installed code, e.g. |
assert_database_compatible(database: str) -> None
Check database's recorded schema version against the code, once per process.
Uses the SchemaVersionTable bound to database; a database without
one (e.g. a lab's own schema) is not checked.
Raises:
| Type | Description |
|---|---|
SchemaVersionError
|
If the recorded version is missing or differs. |
Return the most recently applied schema version, or None if unset.
check_schema_version(expected_version: str, version_table: type[Manual]) -> SchemaVersionStatus
Compare expected_version (code) to the latest DB version row.
Require DB version to match code; raise SchemaVersionError otherwise.