Welcome to Atlas
Atlas is a language-independent tool for managing and migrating database schemas using modern DevOps principles. It offers two workflows:
-
Declarative: Similar to Terraform, Atlas compares the current state of the database to the desired state, as defined in an HCL, SQL, or ORM schema. Based on this comparison, it generates and executes a migration plan to transition the database to its desired state.
-
Versioned: Unlike other tools, Atlas automatically plans schema migrations for you. Users can describe their desired database schema in HCL, SQL, or their chosen ORM, and by utilizing Atlas, they can plan, lint, and apply the necessary migrations to the database.
Quick Start
Get started with Atlas in under 5 minutes.
Installation
- macOS + Linux
- Homebrew
- Docker
- Windows
- Manual Installation
To download and install the latest release of the Atlas CLI, simply run the following in your terminal:
curl -sSf https://atlasgo.sh | sh
Get the latest release with Homebrew:
brew install ariga/tap/atlas
To pull the Atlas image and run it as a Docker container:
docker pull arigaio/atlas
docker run --rm arigaio/atlas --help
If the container needs access to the host network or a local directory, use the --net=host flag and mount the desired directory:
docker run --rm --net=host \
-v $(pwd)/migrations:/migrations \
arigaio/atlas migrate apply
--url "mysql://root:pass@:3306/test"
Download the latest release and move the atlas binary to a file location on your system PATH.
The default binaries distributed in official releases are released under the Atlas EULA. If you would like obtain a copy of Atlas Community Edition (under an Apache 2 license) follow the instructions here.
Schema-as-Code
Choose your preferred way to represent the desired state of your database.
SQL
Describe your database schema with native SQL.
Atlas HCL
The HCL-based language allows developers to describe database schemas in a declarative manner.
ORM
Represent your database with your ORM.
Generating Migration
Atlas offers two workflows to generate and plan migration changes, choose which one works best for you. In both workflows, Atlas automatically plans schema migrations based on your desired schema.
Declarative Migrations
Set up a Terraform-like workflow where each migration is calculated as the diff between your desired state and the current state of the database.
Versioned Migration
Set up a migration directory for your project, creating a version-controlled source of truth of your database schema.
Verifying Migration Safety
Atlas verifies your migrations by running them against various checks to ensure their safety and validity. Verify these changes locally, or as part of your CI process.
CLI
Verify your migration files in your CLI.
GitHub
Setup automatic migration linting with GitHub Actions.
Gitlab
Setup automatic migration linting with GitLab CI.
Deploying Migrations
Deploy migrations to target databases in production by integrating natively with the rest of your infrastructure management. CLI
Deploy migrations from your CLI.
GitHub
Setup deployments with GitHub Actions.
Gitlab
Setup deployments with GitLab CI.
Terraform Provider
Use Atlas with Terraform to manage database schema changes.
Kubernetes Operator
Use the Atlas Kubernetes Operator to manage database schema changes.
Testing Framework
Atlas provides a database testing framework that allows you to test database schemas and migrations much like you would test your own code.
Schema Test
Test your database schema using familiar software testing paradigms.
Migrate Test
Write tests for schema migrations.
Atlas Cloud
Gain full visibility into the databases in your development and production environments with visualizations, detailed logs and troubleshooting capabilities.
Getting Started
Push your database schema to the Cloud to maintain a single source of truth for database schemas with auto-generated documentation.
Setup CI
Simulate and analyze changes to catch destructive changes, backward-incompatibility issues, accidental table locks, and constraint violations way before they reach production.
Deployments
Gain full visibility into the database schema in your production environments with detailed logs and troubleshooting capabilities.
Supported Databases
All Databases
Latest Guides
View all guides
Modern Database CI/CD