
Security News
vlt Launches "reproduce": A New Tool Challenging the Limits of Package Provenance
vlt's new "reproduce" tool verifies npm packages against their source code, outperforming traditional provenance adoption in the JavaScript ecosystem.
atlas-provider-sqlalchemy
Advanced tools
Load SQLAlchemy models into an Atlas project.
atlas schema apply --env sqlalchemy
to apply your SQLAlchemy schema to the database.atlas migrate diff --env sqlalchemy
to automatically plan a migration from the current database version to the SQLAlchemy schema.Install Atlas from macOS or Linux by running:
curl -sSf https://atlasgo.sh | sh
See atlasgo.io for more installation options.
Install the provider by running:
# The Provider works by importing your SQLAlchemy models and extracting the schema from them.
# Therefore, you will need to run the provider from within your project's Python environment.
pip install atlas-provider-sqlalchemy
If all of your SQLAlchemy models exist in a single package, you can use the provider directly to load your SQLAlchemy schema into Atlas.
In your project directory, create a new file named atlas.hcl
with the following contents:
data "external_schema" "sqlalchemy" {
program = [
"atlas-provider-sqlalchemy",
"--path", "./path/to/models",
"--dialect", "mysql" // mariadb | postgresql | sqlite | mssql
]
}
env "sqlalchemy" {
src = data.external_schema.sqlalchemy.url
dev = "docker://mysql/8/dev"
migration {
dir = "file://migrations"
}
format {
migrate {
diff = "{{ sql . \" \" }}"
}
}
}
If you want to use the provider as a python script, you can use the provider as follows:
Create a new file named load_models.py
with the following contents:
# import all models
from models import User, Task
from atlas_provider_sqlalchemy.ddl import print_ddl
print_ddl("mysql", [User, Task])
Next, in your project directory, create a new file named atlas.hcl
with the following contents:
data "external_schema" "sqlalchemy" {
program = [
"python",
"load_models.py"
]
}
env "sqlalchemy" {
src = data.external_schema.sqlalchemy.url
dev = "docker://mysql/8/dev"
migration {
dir = "file://migrations"
}
format {
migrate {
diff = "{{ sql . \" \" }}"
}
}
}
Once you have the provider installed, you can use it to apply your SQLAlchemy schema to the database:
You can use the atlas schema apply
command to plan and apply a migration of your database to your current SQLAlchemy schema.
This works by inspecting the target database and comparing it to the SQLAlchemy schema and creating a migration plan.
Atlas will prompt you to confirm the migration plan before applying it to the database.
atlas schema apply --env sqlalchemy -u "mysql://root:password@localhost:3306/mydb"
Where the -u
flag accepts the URL to the
target database.
Atlas supports a version migration
workflow, where each change to the database is versioned and recorded in a migration file. You can use the
atlas migrate diff
command to automatically generate a migration file that will migrate the database
from its latest revision to the current SQLAlchemy schema.
atlas migrate diff --env sqlalchemy
The provider supports the following databases:
The code in this repository is based on noamtamir/atlas-provider-sqlalchemy.
Please report any issues or feature requests in the ariga/atlas repository.
This project is licensed under the Apache License 2.0.
FAQs
Load sqlalchemy models into an Atlas project.
We found that atlas-provider-sqlalchemy demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
vlt's new "reproduce" tool verifies npm packages against their source code, outperforming traditional provenance adoption in the JavaScript ecosystem.
Research
Security News
Socket researchers uncovered a malicious PyPI package exploiting Deezer’s API to enable coordinated music piracy through API abuse and C2 server control.
Research
The Socket Research Team discovered a malicious npm package, '@ton-wallet/create', stealing cryptocurrency wallet keys from developers and users in the TON ecosystem.