No project description provided
Project description
atlas-provider-django
Load Django models into an Atlas project.
Use-cases
- Declarative migrations - use a Terraform-like
atlas schema apply --env django
to apply your Django schema to the database. - Automatic migration planning - use
atlas migrate diff --env django
to automatically plan a migration from the current database version to the Django schema.
Installation
Install Atlas for macOS or Linux by running:
curl -sSf https://atlasgo.sh | sh
See atlasgo.io for more installation options.
Install the provider by running:
pip install altas-provider-django
Configuration
Add the provider to your Django project's INSTALLED_APPS
in settings.py
:
INSTALLED_APPS = [
...,
'altas_provider_django',
...
]
In your project directory, create a new file named atlas.hcl
with the following contents:
data "external_schema" "django" {
program = [
"python",
"manage.py",
"atlas-provider-django",
"--dialect", "mysql" // mariadb | postgresql | sqlite
// if you want to only load a subset of your app models, you can specify the apps by adding
// "--apps", "app1", "app2", "app3"
]
}
env "django" {
src = data.external_schema.django.url
dev = "docker://mysql/8/dev"
migration {
dir = "file://migrations"
}
format {
migrate {
diff = "{{ sql . \" \" }}"
}
}
}
Usage
Apply
You can use the atlas schema apply
command to plan and apply a migration of your database to your current Django schema.
This works by inspecting the target database and comparing it to the Django Apps models and creating a migration plan.
Atlas will prompt you to confirm the migration plan before applying it to the database.
atlas schema apply --env django -u "mysql://root:password@localhost:3306/mydb"
Where the -u
flag accepts the URL to the
target database.
Diff
Atlas supports a versioned migrations
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 Django schema.
atlas migrate diff --env django
Supported Databases
The provider supports the following databases:
- MySQL
- MariaDB
- PostgreSQL
- SQLite
Issues
Please report any issues or feature requests in the ariga/atlas repository.
License
This project is licensed under the Apache License 2.0.
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 atlas_provider_django-0.1.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f544a1789221c5aabb250089ca117ecb9f9df3ffd2048460d0b49cb3dbab591a |
|
MD5 | 95ef0fcef1fe638e7858ce643050e576 |
|
BLAKE2b-256 | 6c07269b621907f6cd8b5c7a895656bbfbdd8d83b9c3e994492acb0cbf5ae28e |
Hashes for atlas_provider_django-0.1.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d23f23cabf215a6d3846789c454e4192da80fd1c36086522c6450713007424db |
|
MD5 | 29fc956d44934b3bf50e62bbd02867a7 |
|
BLAKE2b-256 | d8dbe2c2e7af842b3e2b5c49772c5bc0f0e0bf6e7abd9a2e9241ae9dd2b0cd23 |