statement

package

Go to main page

Versions in this module

v0

v0.11.2

Mar 16, 2026

v0.11.1

Mar 16, 2026

Changes in this version

type AbstractStatement

+ func (a *AbstractStatement) IsDropTable() bool

+ func (a *AbstractStatement) IsRenameTable() bool

+ type Classification struct

+ Schema string

+ Table string

+ Type StatementType

+ func Classify(sql string) ([]Classification, error)

+ type StatementType int

+ const StatementAlterTable

+ const StatementCreateIndex

+ const StatementCreateTable

+ const StatementDelete

+ const StatementDropTable

+ const StatementInsert

+ const StatementRenameTable

+ const StatementTruncateTable

+ const StatementUnknown

+ const StatementUpdate

+ func (t StatementType) IsDDL() bool

+ func (t StatementType) IsDML() bool

+ func (t StatementType) String() string

v0.11.0

Mar 4, 2026

Changes in this version

type CreateTable

+ func (ct *CreateTable) Diff(target *CreateTable, opts *DiffOptions) ([]*AbstractStatement, error)

+ type DiffOptions struct

+ IgnoreAutoIncrement bool

+ IgnoreCharsetCollation bool

+ IgnoreEngine bool

+ IgnorePartitioning bool

+ IgnoreRowFormat bool

+ func NewDiffOptions() *DiffOptions

type ForeignKeyReference

+ OnDelete *string

+ OnUpdate *string

type Index

+ ColumnList []IndexColumn

+ type IndexColumn struct

+ Expression *string

+ Length *int

+ Name string

v0.10.2

Feb 2, 2026

v0.10.1

Jan 19, 2026

Changes in this version

+ func GetMissingSecondaryIndexes(sourceCreateTable, targetCreateTable, tableName string) (string, error)

+ func RemoveSecondaryIndexes(createStmt string) (string, error)

v0.10.0

Nov 6, 2025

Changes in this version

+ var ErrAlterContainsUnique = errors.New("ALTER contains adding a unique index")

+ var ErrMixMatchMultiStatements = errors.New(...)

+ var ErrMultipleAlterClauses = errors.New(...)

+ var ErrMultipleSchemas = errors.New("statement attempts to modify tables across multiple schemas")

+ var ErrNoStatements = errors.New("could not find any compatible statements to execute")

+ var ErrNotAlterTable = errors.New("not an ALTER TABLE statement")

+ var ErrNotSupportedStatement = errors.New("not a supported statement type")

+ var ErrUnsafeForInplace = errors.New("statement contains operations that are not safe for INPLACE algorithm")

+ func ByName[T HasName](slice []T, name string) *T

+ type AbstractStatement struct

+ Alter string

+ Schema string

+ Statement string

+ StmtNode *ast.StmtNode

+ Table string

+ func MustNew(statement string) []*AbstractStatement

+ func New(statement string) ([]*AbstractStatement, error)

+ func (a *AbstractStatement) AlgorithmInplaceConsideredSafe() error

+ func (a *AbstractStatement) AlterContainsAddUnique() error

+ func (a *AbstractStatement) AlterContainsUnsupportedClause() error

+ func (a *AbstractStatement) AsAlterTable() (*ast.AlterTableStmt, bool)

+ func (a *AbstractStatement) IsAlterTable() bool

+ func (a *AbstractStatement) IsCreateTable() bool

+ func (a *AbstractStatement) ParseCreateTable() (*CreateTable, error)

+ func (a *AbstractStatement) TrimAlter() string

+ type Column struct

+ AutoInc bool

+ Charset *string

+ Collation *string

+ Comment *string

+ Default *string

+ EnumValues []string

+ Length *int

+ Name string

+ Nullable bool

+ Options map[string]string

+ Precision *int

+ PrimaryKey bool

+ Raw *ast.ColumnDef

+ Scale *int

+ SetValues []string

+ Type string

+ Unique bool

+ Unsigned *bool

+ func (c Column) GetName() string

+ type Columns []Column

+ func (columns Columns) ByName(name string) *Column

+ type Constraint struct

+ Columns []string

+ Definition *string

+ Expression *string

+ Name string

+ Options map[string]any

+ Raw *ast.Constraint

+ References *ForeignKeyReference

+ Type string

+ func (c Constraint) GetName() string

+ type Constraints []Constraint

+ func (constraints Constraints) ByName(name string) *Constraint

+ func (constraints Constraints) HasForeignKeys() bool

+ type CreateTable struct

+ Columns Columns

+ Constraints Constraints

+ IfNotExists bool

+ Indexes Indexes

+ Partition *PartitionOptions

+ Raw *ast.CreateTableStmt

+ TableName string

+ TableOptions *TableOptions

+ Temporary bool

+ func ParseCreateTable(sql string) (*CreateTable, error)

+ func (ct *CreateTable) GetColumns() Columns

+ func (ct *CreateTable) GetConstraints() Constraints

+ func (ct *CreateTable) GetCreateTable() *CreateTable

+ func (ct *CreateTable) GetIndexes() Indexes

+ func (ct *CreateTable) GetPartition() *PartitionOptions

+ func (ct *CreateTable) GetTableName() string

+ func (ct *CreateTable) GetTableOptions() map[string]any

+ type ForeignKeyReference struct

+ Columns []string

+ Table string

+ type HasName interface

+ GetName func() string

+ type Index struct

+ Columns []string

+ Comment *string

+ Invisible *bool

+ KeyBlockSize *uint64

+ Name string

+ Options map[string]string

+ ParserName *string

+ Raw *ast.Constraint

+ Type string

+ Using *string

+ func (i Index) GetName() string

+ type Indexes []Index

+ func (indexes Indexes) ByName(name string) *Index

+ func (indexes Indexes) HasInvisible() bool

+ type PartitionDefinition struct

+ Comment *string

+ Engine *string

+ Name string

+ Options map[string]any

+ SubPartitions []SubPartitionDefinition

+ Values *PartitionValues

+ type PartitionOptions struct

+ Columns []string

+ Definitions []PartitionDefinition

+ Expression *string

+ Linear bool

+ Partitions uint64

+ SubPartition *SubPartitionOptions

+ Type string

+ type PartitionValues struct

+ Type string

+ Values []any

+ type SubPartitionDefinition struct

+ Comment *string

+ Engine *string

+ Name string

+ Options map[string]any

+ type SubPartitionOptions struct

+ Columns []string

+ Count uint64

+ Expression *string

+ Linear bool

+ Type string

+ type TableOptions struct

+ AutoIncrement *uint64

+ Charset *string

+ Collation *string

+ Comment *string

+ Engine *string

+ RowFormat *string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL