Documentation
¶
Overview ¶
Package cmdext provides extensions to the Atlas CLI that may be moved to a separate repository in the future.
Index ¶
- Variables
- func AtlasConfig(ctx *hcl.EvalContext, block *hclsyntax.Block) (cty.Value, error)
- func QuerySrc(ctx *hcl.EvalContext, block *hclsyntax.Block) (cty.Value, error)
- func RemoteDir(ctx *hcl.EvalContext, block *hclsyntax.Block) (cty.Value, error)
- func RuntimeVarSrc(c *hcl.EvalContext, block *hclsyntax.Block) (cty.Value, error)
- func TemplateDir(ctx *hcl.EvalContext, block *hclsyntax.Block) (cty.Value, error)
- type EntLoader
- type LoadStateOptions
- type MigrateDiffOptions
- type MigrateDiffer
- type StateLoader
Constants ¶
This section is empty.
Variables ¶
var DataSources = []schemahcl.Option{ schemahcl.WithDataSource("sql", QuerySrc), schemahcl.WithDataSource("runtimevar", RuntimeVarSrc), schemahcl.WithDataSource("template_dir", TemplateDir), schemahcl.WithDataSource("remote_dir", RemoteDir), schemahcl.WithInitBlock("atlas", AtlasConfig), }
DataSources exposes the data sources provided by this package.
var States = registry{ "ent": EntLoader{}, }
States is a global registry for external state loaders.
Functions ¶
func AtlasConfig ¶ added in v0.10.0
AtlasConfig is the handler for the "atlas" init block.
atlas {
cloud {
token = data.runtimevar.token // User token.
url = var.cloud_url // Optional URL.
}
}
func QuerySrc ¶
QuerySrc exposes the database/sql.Query as a schemahcl datasource.
data "sql" "tenants" {
url = var.url
query = <query>
args = [<arg1>, <arg2>, ...]
}
env "prod" {
for_each = toset(data.sql.tenants.values)
url = urlsetpath(var.url, each.value)
}
func RemoteDir ¶ added in v0.10.0
RemoteDir is a data source that reads a remote migration directory.
func RuntimeVarSrc ¶
RuntimeVarSrc exposes the gocloud.dev/runtimevar as a schemahcl datasource.
data "runtimevar" "pass" {
url = "driver://path?query=param"
}
locals {
url = "mysql://root:${data.runtimevar.pass}@:3306/"
}
func TemplateDir ¶ added in v0.9.1
TemplateDir implements migrate.Dir interface for template directories.
data "template_dir" "name" {
path = "path/to/directory"
vars = {
Env = atlas.env
Seed = var.seed
}
}
env "dev" {
url = "driver://path?query=param"
migration {
dir = data.template_dir.name.url
}
}
Types ¶
type EntLoader ¶ added in v0.9.1
type EntLoader struct{}
EntLoader is a StateLoader for loading ent.Schema's as StateReader's.
func (EntLoader) LoadState ¶ added in v0.9.1
func (l EntLoader) LoadState(ctx context.Context, opts *LoadStateOptions) (migrate.StateReader, error)
LoadState returns a migrate.StateReader that reads the schema from an ent.Schema.
func (EntLoader) MigrateDiff ¶ added in v0.9.1
func (l EntLoader) MigrateDiff(ctx context.Context, opts *MigrateDiffOptions) error
MigrateDiff returns the diff between ent.Schema and a directory.
type LoadStateOptions ¶ added in v0.9.1
type LoadStateOptions struct {
URLs []*url.URL
Dev *sqlclient.Client // Client for the dev database.
}
LoadStateOptions for external state loaders.
type MigrateDiffOptions ¶ added in v0.9.1
type MigrateDiffOptions struct {
Name string
Indent string
To []string
Dir migrate.Dir
Dev *sqlclient.Client
}
MigrateDiffOptions for external migration differ.
type MigrateDiffer ¶ added in v0.9.1
type MigrateDiffer interface {
MigrateDiff(context.Context, *MigrateDiffOptions) error
// contains filtered or unexported methods
}
MigrateDiffer allows external sources to implement custom migration differs.
type StateLoader ¶ added in v0.9.1
type StateLoader interface {
LoadState(context.Context, *LoadStateOptions) (migrate.StateReader, error)
}
StateLoader allows loading StateReader's from external sources.
Source Files