README
¶
Atlas - A Database Toolkit
Atlas is a CLI designed to help companies better work with their data. It includes several components that can be used individually but are designed to work very well together.
Supported databases:
- MySQL
- MariaDB
- PostgresSQL
- SQLite
- TiDB
Runs on all platforms:
- Mac
- Linux
- Windows
Quick Installation
On macOS:
brew install ariga/tap/atlas
Instructions for other platforms and databases: Getting Started.
Getting Started
Schema Inspection
Inspect and save output to a schema file.
atlas schema inspect -u "mysql://root:pass@tcp(localhost:3306)/example" > atlas.hcl
Apply change to Schema
atlas schema apply -u "mysql://root:pass@tcp(localhost:3306)/example" -f atlas.hcl
Full CLI documentation.
About the Project
Read more about the motivation of the project Here.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
atlascmd
Package atlascmd holds the atlas commands used to build an atlas distribution.
|
Package atlascmd holds the atlas commands used to build an atlas distribution. |
|
internal
|
|
|
schema
|
|
|
schemaspec
Package schemaspec provides types designed to capture atlas schema elements, and create type-safe extensions to the configuration language.
|
Package schemaspec provides types designed to capture atlas schema elements, and create type-safe extensions to the configuration language. |
|
sql
|
|
|
sqltool
Package sqltool contains logic to integrate existing tools like Flyway or Liquibase with the Atlas CLI.
|
Package sqltool contains logic to integrate existing tools like Flyway or Liquibase with the Atlas CLI. |
Click to show internal directories.
Click to hide internal directories.