atlasexec

type AppliedFile struct {
	File
	Start   time.Time
	End     time.Time
	Skipped int      // Amount of skipped SQL statements in a partially applied file.
	Applied []string // SQL statements applied with success
	Error   *struct {
		SQL   string // SQL statement that failed.
		Error string // Error returned by the database.
	}
}

type Changes struct {
	Applied []string   `json:"Applied,omitempty"` // SQL changes applied with success
	Pending []string   `json:"Pending,omitempty"` // SQL changes that were not applied
	Error   *StmtError `json:"Error,omitempty"`   // Error that occurred during applying
}

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

type DeployRunContext struct {
	TriggerType    TriggerType `json:"triggerType,omitempty"`
	TriggerVersion string      `json:"triggerVersion,omitempty"`
}

type Env struct {
	Driver string         `json:"Driver,omitempty"` // Driver name.
	URL    *sqlclient.URL `json:"URL,omitempty"`    // URL to dev database.
	Dir    string         `json:"Dir,omitempty"`    // Path to migration directory.
}

type File struct {
	Name        string `json:"Name,omitempty"`
	Version     string `json:"Version,omitempty"`
	Description string `json:"Description,omitempty"`
}

type FileReport struct {
	Name    string            `json:"Name,omitempty"`    // Name of the file.
	Text    string            `json:"Text,omitempty"`    // Contents of the file.
	Reports []sqlcheck.Report `json:"Reports,omitempty"` // List of reports.
	Error   string            `json:"Error,omitempty"`   // File specific error.
}

type LoginParams struct {
	Token string
}

type MigrateApply struct {
	Pending []File         `json:"Pending,omitempty"` // Pending migration files
	Applied []*AppliedFile `json:"Applied,omitempty"` // Applied files
	Current string         `json:"Current,omitempty"` // Current migration version
	Target  string         `json:"Target,omitempty"`  // Target migration version
	Start   time.Time
	End     time.Time
	// Error is set even then, if it was not caused by a statement in a migration file,
	// but by Atlas, e.g. when committing or rolling back a transaction.
	Error string `json:"Error,omitempty"`
}

type MigrateApplyError struct {
	Result []*MigrateApply
}

type MigrateApplyParams struct {
	Env             string
	ConfigURL       string
	Context         *DeployRunContext
	DirURL          string
	AllowDirty      bool
	URL             string
	RevisionsSchema string
	BaselineVersion string
	TxMode          string
	ExecOrder       MigrateExecOrder
	Amount          uint64
	DryRun          bool
	Vars            Vars
}

type MigrateDown struct {
	Planned  []File          `json:"Planned,omitempty"`  // Pending migration files
	Reverted []*RevertedFile `json:"Reverted,omitempty"` // Applied files
	Current  string          `json:"Current,omitempty"`  // Current migration version
	Target   string          `json:"Target,omitempty"`   // Target migration version
	Total    int             `json:"Total,omitempty"`    // Total number of migrations to revert
	Start    time.Time
	End      time.Time
	// URL and Status are set only when the migration is planned or executed in the cloud.
	URL    string `json:"URL,omitempty"`
	Status string `json:"Status,omitempty"`
	// Error is set even then, if it was not caused by a statement in a migration file,
	// but by Atlas, e.g. when committing or rolling back a transaction.
	Error string `json:"Error,omitempty"`
}

type MigrateDownParams struct {
	Env             string
	ConfigURL       string
	DevURL          string
	Context         *DeployRunContext
	DirURL          string
	URL             string
	RevisionsSchema string
	Amount          uint64
	ToVersion       string
	ToTag           string
	Vars            Vars
}

type MigrateExecOrder string

type MigrateLintParams struct {
	Env       string
	ConfigURL string
	DevURL    string
	DirURL    string
	Context   *RunContext
	Web       bool
	Latest    uint64
	Vars      Vars
	Writer    io.Writer
	Base      string
	Format    string
}

type MigratePushParams struct {
	Name        string
	Tag         string
	DevURL      string
	DirURL      string
	DirFormat   string
	LockTimeout string
	Context     *RunContext
	ConfigURL   string
	Env         string
	Vars        Vars
}

type MigrateStatus struct {
	Available []File      `json:"Available,omitempty"` // Available migration files
	Pending   []File      `json:"Pending,omitempty"`   // Pending migration files
	Applied   []*Revision `json:"Applied,omitempty"`   // Applied migration files
	Current   string      `json:"Current,omitempty"`   // Current migration version
	Next      string      `json:"Next,omitempty"`      // Next migration version
	Count     int         `json:"Count,omitempty"`     // Count of applied statements of the last revision
	Total     int         `json:"Total,omitempty"`     // Total statements of the last migration
	Status    string      `json:"Status,omitempty"`    // Status of migration (OK, PENDING)
	Error     string      `json:"Error,omitempty"`     // Last Error that occurred
	SQL       string      `json:"SQL,omitempty"`       // SQL that caused the last Error
}

type MigrateStatusParams struct {
	Env             string
	ConfigURL       string
	DirURL          string
	URL             string
	RevisionsSchema string
	Vars            Vars
}

type Option func(ce *WorkingDir) error

type RevertedFile struct {
	File
	Start   time.Time
	End     time.Time
	Skipped int      // Amount of skipped SQL statements in a partially applied file.
	Applied []string // SQL statements applied with success
	Scope   string   // Scope of the revert. e.g., statement, versions, etc.
	Error   *struct {
		SQL   string // SQL statement that failed.
		Error string // Error returned by the database.
	}
}

type Revision struct {
	Version         string        `json:"Version"`             // Version of the migration.
	Description     string        `json:"Description"`         // Description of this migration.
	Type            string        `json:"Type"`                // Type of the migration.
	Applied         int           `json:"Applied"`             // Applied amount of statements in the migration.
	Total           int           `json:"Total"`               // Total amount of statements in the migration.
	ExecutedAt      time.Time     `json:"ExecutedAt"`          // ExecutedAt is the starting point of execution.
	ExecutionTime   time.Duration `json:"ExecutionTime"`       // ExecutionTime of the migration.
	Error           string        `json:"Error,omitempty"`     // Error of the migration, if any occurred.
	ErrorStmt       string        `json:"ErrorStmt,omitempty"` // ErrorStmt is the statement that raised Error.
	OperatorVersion string        `json:"OperatorVersion"`     // OperatorVersion that executed this migration.
}

type RunContext struct {
	Repo     string `json:"repo,omitempty"`
	Path     string `json:"path,omitempty"`
	Branch   string `json:"branch,omitempty"`
	Commit   string `json:"commit,omitempty"`
	URL      string `json:"url,omitempty"`
	Username string `json:"username,omitempty"` // The username that triggered the event that initiated the command.
	UserID   string `json:"userID,omitempty"`   // The user ID that triggered the event that initiated the command.
	SCMType  string `json:"scmType,omitempty"`  // Source control management system type.
}

type SchemaApply struct {
	Env
	Changes Changes `json:"Changes,omitempty"`
	// General error that occurred during execution.
	// e.g., when committing or rolling back a transaction.
	Error string `json:"Error,omitempty"`
}

type SchemaApplyError struct {
	Result []*SchemaApply
}

type SchemaApplyParams struct {
	Env       string
	ConfigURL string
	DevURL    string
	DryRun    bool
	TxMode    string
	Exclude   []string
	Schema    []string
	To        string
	URL       string
	Vars      Vars
}

type SchemaInspectParams struct {
	Env       string
	ConfigURL string
	DevURL    string
	Exclude   []string
	Format    string
	Schema    []string
	URL       string
	Vars      Vars
}

type StepReport struct {
	Name   string      `json:"Name,omitempty"`   // Step name.
	Text   string      `json:"Text,omitempty"`   // Step description.
	Error  string      `json:"Error,omitempty"`  // Error that cause the execution to halt.
	Result *FileReport `json:"Result,omitempty"` // Result of the step. For example, a diagnostic.
}

type StmtError struct {
	Stmt string `json:"Stmt,omitempty"` // SQL statement that failed.
	Text string `json:"Text,omitempty"` // Error message as returned by the database.
}

type SummaryReport struct {
	URL string `json:"URL,omitempty"` // URL of the report, if exists.

	// Env holds the environment information.
	Env struct {
		Driver string         `json:"Driver,omitempty"` // Driver name.
		URL    *sqlclient.URL `json:"URL,omitempty"`    // URL to dev database.
		Dir    string         `json:"Dir,omitempty"`    // Path to migration directory.
	}

	// Schema versions found by the runner.
	Schema struct {
		Current string `json:"Current,omitempty"` // Current schema.
		Desired string `json:"Desired,omitempty"` // Desired schema.
	}

	// Steps of the analysis. Added in verbose mode.
	Steps []*StepReport `json:"Steps,omitempty"`

	// Files reports. Non-empty in case there are findings.
	Files []*FileReport `json:"Files,omitempty"`
}

type TriggerType string

type Vars map[string]string

type Version struct {
	Version string `json:"Version"`
	SHA     string `json:"SHA,omitempty"`
	Canary  bool   `json:"Canary,omitempty"`
}

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