Atlas Documentation

To save resources, you can run specific tests or subsets of tests using the -run and -dialect flags. This allows you to run tests without having all database containers active, provided the specific containers required by the selected tests are running.

Run specific test functions

Use the -run flag with the test name. To target a specific subtest (e.g., a specific database version), use the slash / syntax.

Run tests for a specific dialect

Use the -dialect flag to filter tests by a specific database version/dialect.

Examples:

• Run TestMySQL_Executor for all MySQL versions: -run='MySQL_Executor'
• Run TestMySQL_Executor for MySQL 5.6 only: -run='MySQL_Executor/mysql56'
• Run TestPostgres_Executor for Postgres 10 only: -run='Postgres_Executor/postgres10'
• Run all TiDB tests for version tidb5: -run='TiDB' -dialect='tidb5'

# Run TestMySQL_Executor for all mysql versions
go test -run='MySQL_Executor' ./... 

# Run TestMySQL_Executor for mysql 5.6 only
go test -run='MySQL_Executor/mysql56' ./...

# Run TestPostgres_Executor for postgres 10 only
go test -run='Postgres_Executor/postgres10' ./...

# Run all tests for one specific dialect, like only TiDB 5
go test -run='TiDB' -dialect='tidb5' ./...

The atlas schema inspect command connects to a database and prints its schema in Atlas DDL syntax. This is useful for generating .hcl files from existing databases.

Usage Examples:

# Inspect a specific database and save to a file
atlas schema inspect -u "mysql://user:pass@localhost:3306/dbname" > schema.hcl

# Inspect multiple specific schemas
atlas schema inspect -u "mariadb://user:pass@localhost:3306/" --schema=schemaA,schemaB -s schemaC

# Inspect a SQLite database
atlas schema inspect -u "sqlite://file:ex1.db?_fk=1"

Flags:

• -u, --url: (Required) The URL of the resource to inspect (e.g., mysql://user:pass@host:port/dbname).
• --dev-url: The URL of a dev database.
• -s, --schema: Set specific schema names to include.
• --exclude: List of glob patterns used to filter resources.
• --format / --log: Go template to use to format the output.

atlas schema inspect -u "mysql://user:pass@localhost:3306/dbname" > schema.hcl
atlas schema inspect -u "mariadb://user:pass@localhost:3306/" --schema=schemaA,schemaB -s schemaC
atlas schema inspect --url "postgres://user:pass@host:port/dbname?sslmode=disable"
atlas schema inspect -u "sqlite://file:ex1.db?_fk=1"

Atlas allows you to define roles, permissions, and row-level security policies using HCL. This enables managing database access control as version-controlled code.

role "app_readonly" {
  comment = "Read-only access for reporting"
}

role "app_writer" {
  comment   = "Read-write access for the application"
  member_of = [role.app_readonly]
}

user "api_user" {
  password   = var.api_password
  conn_limit = 20
  comment    = "Application API service account"
  member_of  = [role.app_writer]
}

permission {
  for_each   = [table.orders, table.products, table.users]
  for        = each.value
  to         = role.app_readonly
  privileges = [SELECT]
}

policy "tenant_isolation" {
  on    = table.orders
  for   = ALL
  to    = ["app_writer"]
  using = "(tenant_id = current_setting('app.current_tenant')::integer)"
  check = "(tenant_id = current_setting('app.current_tenant')::integer)"
}