SQLAlchemy ORM models for the ISPyB database
Project description
This provides a set of SQLAlchemy ORM models for the ISPyB database.
Installation
Install from pypi ispyb-models:
pip install ispyb-models
Basic Usage
from ispyb import models
dataCollection = models.DataCollection(
...
)
ses.add(dataCollection)
ses.commit()
...
datacollections = (
ses.query(
models.DataCollection
).filter(models.DataCollection.dataCollectionId == 1)
).first()
)
Manually generate the DB schema
Checkout the specific tag for a given ispyb-database
version:
$ git clone -b v1.18.1 https://github.com/ispyb/ispyb-database.git
$ # or, if you have an existing copy of the repository:
$ git checkout v1.18.1
Apply the schema patch in patches/circular_references.patch
to avoid circular foreign key references:
$ patch -p1 < ispyb-models/patches/circular_references.patch
Then run the ispyb-database
build.sh
script to generate the database:
$ sh build.sh
Generate the models with sqlacodegen
in src/ispyb/models/
:
sqlacodegen mysql+mysqlconnector://user:password@host:port/ispyb_build --noinflect --outfile _auto_db_schema.py
Do not edit the output file yourself
The resulting _auto_db_schema.py
should not be edited (other than automatic
formatting with black
or sorting of imports with isort
). All models are imported
into and accessed via the __init__.py
. Any modifications, e.g. injecting additional
relationships between models should be done here.
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 ispyb_models-1.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8068e59be206621f9d5266edbb86137cdd19f28a197cf30c09f96cf2abd116dd |
|
MD5 | 2c3381bb8fbb35133d8625eacb0339ac |
|
BLAKE2b-256 | e3743ae436428639b0938b5a18025c7e5ffcb18328ed726fd1aa2fa334d00100 |