migrations

type CallbackFn func(int64)

type CheckConstraint struct {
	Name       string `json:"name"`
	Constraint string `json:"constraint"`
}

type CheckConstraintError struct {
	Table  string
	Column string
	Err    error
}

type Column struct {
	Name       string               `json:"name"`
	Type       string               `json:"type"`
	Nullable   bool                 `json:"nullable"`
	Unique     bool                 `json:"unique"`
	PrimaryKey bool                 `json:"pk"`
	Default    *string              `json:"default"`
	Check      *CheckConstraint     `json:"check"`
	References *ForeignKeyReference `json:"references"`
}

type ColumnAlreadyExistsError struct {
	Table string
	Name  string
}

type ColumnDoesNotExistError struct {
	Table string
	Name  string
}

type ColumnIsNotNullableError struct {
	Table string
	Name  string
}

type ColumnReferenceError struct {
	Table  string
	Column string
	Err    error
}

type EmptyMigrationError struct{}

type FieldRequiredError struct {
	Name string
}

type ForeignKeyReference struct {
	Name   string `json:"name"`
	Table  string `json:"table"`
	Column string `json:"column"`
}

type IndexAlreadyExistsError struct {
	Name string
}

type IndexDoesNotExistError struct {
	Name string
}

type InvalidMigrationError struct {
	Reason string
}

type InvalidPrimaryKeyError struct {
	Table  string
	Fields int
}

type IsolatedOperation interface {
	IsIsolated()
}

type Migration struct {
	Name string `json:"name"`

	Operations Operations `json:"operations"`
}

type MultipleAlterColumnChangesError struct {
	Changes int
}

type NoDownSQLAllowedError struct{}

type NoUpSQLAllowedError struct{}

type OpAddColumn struct {
	Table  string  `json:"table"`
	Up     *string `json:"up"`
	Column Column  `json:"column"`
}

type OpAlterColumn struct {
	Table      string               `json:"table"`
	Column     string               `json:"column"`
	Name       string               `json:"name"`
	Type       string               `json:"type"`
	Check      *CheckConstraint     `json:"check"`
	References *ForeignKeyReference `json:"references"`
	NotNull    *bool                `json:"not_null"`
	Unique     *UniqueConstraint    `json:"unique"`
	Up         string               `json:"up"`
	Down       string               `json:"down"`
}

type OpChangeType struct {
	Table  string `json:"table"`
	Column string `json:"column"`
	Type   string `json:"type"`
	Up     string `json:"up"`
	Down   string `json:"down"`
}

type OpCreateIndex struct {
	Name    string   `json:"name"`
	Table   string   `json:"table"`
	Columns []string `json:"columns"`
}

type OpCreateTable struct {
	Name    string   `json:"name"`
	Columns []Column `json:"columns"`
}

type OpDropColumn struct {
	Table  string  `json:"table"`
	Column string  `json:"column"`
	Down   *string `json:"down,omitempty"`
}

type OpDropConstraint struct {
	Table  string `json:"table"`
	Column string `json:"column"`
	Name   string `json:"name"`
	Up     string `json:"up"`
	Down   string `json:"down"`
}

type OpDropIndex struct {
	Name string `json:"name"`
}

type OpDropTable struct {
	Name string `json:"name"`
}

type OpName string

type OpRawSQL struct {
	Up   string `json:"up"`
	Down string `json:"down,omitempty"`
}

type OpRenameColumn struct {
	Table string `json:"table"`
	From  string `json:"from"`
	To    string `json:"to"`
}

type OpRenameTable struct {
	From string `json:"from"`
	To   string `json:"to"`
}

type OpSetCheckConstraint struct {
	Table  string          `json:"table"`
	Column string          `json:"column"`
	Check  CheckConstraint `json:"check"`
	Up     string          `json:"up"`
	Down   string          `json:"down"`
}

type OpSetForeignKey struct {
	Table      string              `json:"table"`
	Column     string              `json:"column"`
	References ForeignKeyReference `json:"references"`
	Up         string              `json:"up"`
	Down       string              `json:"down"`
}

type OpSetNotNull struct {
	Table  string `json:"table"`
	Column string `json:"column"`
	Up     string `json:"up"`
	Down   string `json:"down"`
}

type OpSetUnique struct {
	Name   string `json:"name"`
	Table  string `json:"table"`
	Column string `json:"column"`
	Up     string `json:"up"`
	Down   string `json:"down"`
}

type Operation interface {
	// Start will apply the required changes to enable supporting the new schema
	// version in the database (through a view)
	// update the given views to expose the new schema version
	Start(ctx context.Context, conn *sql.DB, stateSchema string, s *schema.Schema, cbs ...CallbackFn) error

	// Complete will update the database schema to match the current version
	// after calling Start.
	// This method should be called once the previous version is no longer used
	Complete(ctx context.Context, conn *sql.DB) error

	// Rollback will revert the changes made by Start. It is not possible to
	// rollback a completed migration.
	Rollback(ctx context.Context, conn *sql.DB) error

	// Validate returns a descriptive error if the operation cannot be applied to the given schema
	Validate(ctx context.Context, s *schema.Schema) error
}

type Operations []Operation

type RequiresSchemaRefreshOperation interface {
	RequiresSchemaRefresh()
}

type TableAlreadyExistsError struct {
	Name string
}

type TableDoesNotExistError struct {
	Name string
}

type TriggerDirection string

type UniqueConstraint struct {
	Name string `json:"name"`
}