cmdapi

Documentation

Overview

Package cmdapi holds the atlas commands used to build an atlas distribution.

Index

• Variables
• func EnvByName(name string, opts ...LoadOption) (*Project, []*Env, error)
• func Version() string
• type Diff
  • func (d *Diff) Extend(global *Diff) *Diff
  • func (d *Diff) Options() (opts []schema.DiffOption)
• type Env
  • func (e *Env) DiffOptions() []schema.DiffOption
  • func (e *Env) Sources() ([]string, error)
• type Format
• type Lint
  • func (l *Lint) Extend(global *Lint) *Lint
• type LoadOption
  • func WithInput(values map[string]cty.Value) LoadOption
• type MigrateReport
  • func (r *MigrateReport) CloudEnabled() bool
  • func (r *MigrateReport) Done(cmd *cobra.Command, flags migrateApplyFlags) error
  • func (r *MigrateReport) Init(c *sqlclient.Client, l *cmdlog.MigrateApply, rrw cmdmigrate.RevisionReadWriter)
  • func (r *MigrateReport) RecordTargetID(ctx context.Context) error
• type MigrateReportSet
  • func NewReportProvider(project *Project, envs []*Env) *MigrateReportSet
  • func (s *MigrateReportSet) Flush(cmd *cobra.Command, cmdErr error)
  • func (*MigrateReportSet) RedactedURL(u string) string
  • func (s *MigrateReportSet) ReportFor(flags migrateApplyFlags, e *Env) *MigrateReport
  • func (s *MigrateReportSet) Step(format string, args ...interface{})
  • func (s *MigrateReportSet) StepLog(format string, args ...interface{})
  • func (s *MigrateReportSet) StepLogError(text string)
• type Migration
• type Project
• type SkipChanges
• type Vars
  • func (v Vars) Copy() Vars
  • func (v *Vars) Replace(vc Vars)
  • func (v *Vars) Set(s string) error
  • func (v Vars) String() string
  • func (v *Vars) Type() string

Variables

var (
	// Root represents the root command when called without any subcommands.
	Root = &cobra.Command{
		Use:          "atlas",
		Short:        "A database toolkit.",
		SilenceUsage: true,
	}

	// GlobalFlags contains flags common to many Atlas sub-commands.
	GlobalFlags struct {
		// Config defines the path to the Atlas project/config file.
		ConfigURL string
		// SelectedEnv contains the environment selected from the active project via the --env flag.
		SelectedEnv string
		// Vars contains the input variables passed from the CLI to Atlas DDL or project files.
		Vars Vars
	}
)

Functions

func EnvByName

func EnvByName(name string, opts ...LoadOption) (*Project, []*Env, error)

EnvByName parses and returns the project configuration with selected environments.

func Version

func Version() string

Version returns the current Atlas binary version.

Types

type Diff

type Diff struct {
	// SkipChanges configures the skip changes policy.
	SkipChanges *SkipChanges `spec:"skip"`
	schemahcl.DefaultExtension
}

Diff represents the schema diffing policy.

func (*Diff) Extend

func (d *Diff) Extend(global *Diff) *Diff

Extend allows extending environment blocks with a global one. For example:

diff {
  skip {
    drop_schema = true
  }
}

env "local" {
  ...
  diff {
    concurrent_index {
      create = true
      drop = true
    }
  }
}

func (*Diff) Options

func (d *Diff) Options() (opts []schema.DiffOption)

Options converts the diff policy into options.

type Env

type Env struct {
	// Name for this environment.
	Name string `spec:"name,name"`

	// URL of the database.
	URL string `spec:"url"`

	// URL of the dev-database for this environment.
	// See: https://atlasgo.io/dev-database
	DevURL string `spec:"dev"`

	// List of schemas in this database that are managed by Atlas.
	Schemas []string `spec:"schemas"`

	// Exclude defines a list of glob patterns used to filter
	// resources on inspection.
	Exclude []string `spec:"exclude"`

	// Migration containing the migration configuration of the env.
	Migration *Migration `spec:"migration"`

	// Diff policy of the environment.
	Diff *Diff `spec:"diff"`

	// Lint policy of the environment.
	Lint *Lint `spec:"lint"`

	// Format of the environment.
	Format Format `spec:"format"`

	schemahcl.DefaultExtension
	// contains filtered or unexported fields
}

Env represents an Atlas environment.

func (*Env) DiffOptions

func (e *Env) DiffOptions() []schema.DiffOption

DiffOptions returns the diff options configured for the environment, or nil if no environment or diff policy were set.

func (*Env) Sources

func (e *Env) Sources() ([]string, error)

Sources returns the paths containing the Atlas schema.

type Format

type Format struct {
	Migrate struct {
		// Apply configures the formatting for 'migrate apply'.
		Apply string `spec:"apply"`
		// Lint configures the formatting for 'migrate lint'.
		Lint string `spec:"lint"`
		// Status configures the formatting for 'migrate status'.
		Status string `spec:"status"`
		// Apply configures the formatting for 'migrate diff'.
		Diff string `spec:"diff"`
	} `spec:"migrate"`
	Schema struct {
		// Apply configures the formatting for 'schema apply'.
		Apply string `spec:"apply"`
		// Apply configures the formatting for 'schema diff'.
		Diff string `spec:"diff"`
	} `spec:"schema"`
	schemahcl.DefaultExtension
}

Format represents the output formatting configuration of an environment.

type Lint

type Lint struct {
	// Format configures the --format option.
	Format string `spec:"log"`
	// Latest configures the --latest option.
	Latest int `spec:"latest"`
	Git    struct {
		// Dir configures the --git-dir option.
		Dir string `spec:"dir"`
		// Base configures the --git-base option.
		Base string `spec:"base"`
	} `spec:"git"`
	schemahcl.DefaultExtension
}

Lint represents the configuration of migration linting.

func (*Lint) Extend

func (l *Lint) Extend(global *Lint) *Lint

Extend allows extending environment blocks with a global one. For example:

lint {
  log = <<EOS
    ...
  EOS
}

env "local" {
  ...
  lint {
    latest = 1
  }
}

env "ci" {
  ...
  lint {
    git {
      dir = "../"
      base = "master"
    }
  }
}

type LoadOption

type LoadOption func(*loadConfig)

LoadOption configures the LoadEnv function.

func WithInput

func WithInput(values map[string]cty.Value) LoadOption

WithInput is a LoadOption that sets the input values for the LoadEnv function.

type MigrateReport

type MigrateReport struct {
	// contains filtered or unexported fields
}

MigrateReport responsible for reporting 'migrate apply' reports.

func (*MigrateReport) CloudEnabled

func (r *MigrateReport) CloudEnabled() bool

CloudEnabled reports if cloud reporting is enabled.

func (*MigrateReport) Done

func (r *MigrateReport) Done(cmd *cobra.Command, flags migrateApplyFlags) error

Done closes and flushes this report.

func (*MigrateReport) Init

func (r *MigrateReport) Init(c *sqlclient.Client, l *cmdlog.MigrateApply, rrw cmdmigrate.RevisionReadWriter)

Init the report if the necessary dependencies.

func (*MigrateReport) RecordTargetID

func (r *MigrateReport) RecordTargetID(ctx context.Context) error

RecordTargetID asks the revisions-table to allow or provide the target identifier if cloud reporting is enabled.

type MigrateReportSet

type MigrateReportSet struct {
	cloudapi.ReportMigrationSetInput
	// contains filtered or unexported fields
}

MigrateReportSet is a set of reports.

func NewReportProvider

func NewReportProvider(project *Project, envs []*Env) *MigrateReportSet

NewReportProvider returns a new ReporterProvider.

func (*MigrateReportSet) Flush

func (s *MigrateReportSet) Flush(cmd *cobra.Command, cmdErr error)

Flush report the migration deployment to the cloud. The current implementation is simplistic and sends each report separately without marking them as part of a group.

Note that reporting errors are logged, but not cause Atlas to fail.

func (*MigrateReportSet) RedactedURL

func (*MigrateReportSet) RedactedURL(u string) string

RedactedURL returns the redacted URL of the given environment at index i.

func (*MigrateReportSet) ReportFor

func (s *MigrateReportSet) ReportFor(flags migrateApplyFlags, e *Env) *MigrateReport

ReportFor returns a new MigrateReport for the given environment.

func (*MigrateReportSet) Step

func (s *MigrateReportSet) Step(format string, args ...interface{})

Step starts a new reporting step.

func (*MigrateReportSet) StepLog

func (s *MigrateReportSet) StepLog(format string, args ...interface{})

StepLog logs a line to the current reporting step.

func (*MigrateReportSet) StepLogError

func (s *MigrateReportSet) StepLogError(text string)

StepLogError logs a line to the current reporting step.

type Migration

type Migration struct {
	Dir             string `spec:"dir"`
	Format          string `spec:"format"`
	Baseline        string `spec:"baseline"`
	LockTimeout     string `spec:"lock_timeout"`
	RevisionsSchema string `spec:"revisions_schema"`
}

Migration represents the migration directory for the Env.

type Project

type Project struct {
	Envs []*Env `spec:"env"`  // List of environments
	Lint *Lint  `spec:"lint"` // Optional global lint policy
	Diff *Diff  `spec:"diff"` // Optional global diff policy
	// contains filtered or unexported fields
}

Project represents an atlas.hcl project config file.

type SkipChanges

type SkipChanges struct {
	AddSchema        bool `spec:"add_schema"`
	DropSchema       bool `spec:"drop_schema"`
	ModifySchema     bool `spec:"modify_schema"`
	AddTable         bool `spec:"add_table"`
	DropTable        bool `spec:"drop_table"`
	ModifyTable      bool `spec:"modify_table"`
	AddColumn        bool `spec:"add_column"`
	DropColumn       bool `spec:"drop_column"`
	ModifyColumn     bool `spec:"modify_column"`
	AddIndex         bool `spec:"add_index"`
	DropIndex        bool `spec:"drop_index"`
	ModifyIndex      bool `spec:"modify_index"`
	AddForeignKey    bool `spec:"add_foreign_key"`
	DropForeignKey   bool `spec:"drop_foreign_key"`
	ModifyForeignKey bool `spec:"modify_foreign_key"`
}

SkipChanges represents the skip changes policy.

type Vars

type Vars map[string]cty.Value

Vars implements pflag.Value.

func (Vars) Copy

func (v Vars) Copy() Vars

Copy returns a copy of the current variables.

func (*Vars) Replace

func (v *Vars) Replace(vc Vars)

Replace overrides the variables.

func (*Vars) Set

func (v *Vars) Set(s string) error

Set implements pflag.Value.Set.

func (Vars) String

func (v Vars) String() string

String implements pflag.Value.String.

func (*Vars) Type

func (v *Vars) Type() string

Type implements pflag.Value.Type.