The schema of 3Di schematization files
Project description
threedi-schema
The schema of 3Di schematisation files.
This project exposes:
A ThreediDatabase object to interact with schematisation files.
A ModelSchema object (ThreediDatabase().schema) for adapting schema versions (called “migration”).
The 3Di schema as SQLAlchemy models and python Enum classes.*
*This package exposes SQLAlchemy models of the schematisation files directly. A minor release of this package may change these models and will be backwards incompatible. If the SQLAlchemy models are used, we strongly advise to fix the minor version as follows: threedi-schema==0.214.*. Otherwise, just fixing the major version is sufficient.
Example
The following code sample shows how you can upgrade a schematisation file:
from threedi_schema import ThreediDatabase db = ThreediDatabase("<Path to your sqlite file>") db.schema.upgrade()
The following code sample shows how you can list Channel objects:
from threedi_schema import models # NB: Ensure that you pin the minor version of threedi-schema # when using models (or constants). channels = db.get_session().query(models.Channel).all()
Command-line interface
Migrate to the latest schema version:
threedi_schema -s path/to/model.sqlite migrate
Ensure presence of spatial indexes:
threedi_schema -s path/to/model.sqlite index
Installation
Install with:
$ pip install threedi-schema
Changelog of threedi-schema
0.214.4 (2023-01-31)
Properly cleanup geo-tables in migration 214.
0.214.3 (2023-01-19)
Adapted versioning: prefix existing versions with 0.
Fixed deprecation warnings of Geoalchemy2 0.13.0
0.214.2 (2023-01-17)
Fixed packaging (also include migrations).
0.214.1 (2023-01-17)
Fixed packaging.
0.214.0 (2023-01-17)
Initial project structure created with cookiecutter and https://github.com/nens/cookiecutter-python-template
Ported code from threedi-modelchecker, rearranged into ‘domain’, ‘application’, ‘infrastructure’, ‘migrations’.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for threedi_schema-0.214.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 72b174cf9076828175a3250a104d83c3bbc2887e87fa210ac1a8d0089504a2a7 |
|
MD5 | 9321023f214125db3d7bbe152fe73b1c |
|
BLAKE2b-256 | f46577f7129e3a81f9ec2acd51bfc35c2857e573d40594d5abe49ea2a4c148c3 |