Package: gorm.io/gorm/migrator

type BuildIndexOptionsInterface (interface) BuildIndexOptionsInterface build index options interface Methods (only one) ( BuildIndexOptionsInterface) BuildIndexOptions([]schema.IndexOption, *gorm.Statement) []interface{} Implemented By (at least 3) Migrator gorm.io/driver/mysql.Migrator gorm.io/driver/postgres.Migrator

type ColumnType (struct) ColumnType column type implements ColumnType interface Fields (total 14) AutoIncrementValue sql.NullBool ColumnTypeValue sql.NullString CommentValue sql.NullString DataTypeValue sql.NullString DecimalSizeValue sql.NullInt64 DefaultValueValue sql.NullString LengthValue sql.NullInt64 NameValue sql.NullString NullableValue sql.NullBool PrimaryKeyValue sql.NullBool SQLColumnType *sql.ColumnType ScaleValue sql.NullInt64 ScanTypeValue reflect.Type UniqueValue sql.NullBool Methods (total 12) ( ColumnType) AutoIncrement() (isAutoIncrement bool, ok bool) AutoIncrement returns the column is auto increment or not. ( ColumnType) ColumnType() (columnType string, ok bool) ColumnType returns the database type of the column. like `varchar(16)` ( ColumnType) Comment() (value string, ok bool) Comment returns the comment of current column. ( ColumnType) DatabaseTypeName() string DatabaseTypeName returns the database system name of the column type. If an empty string is returned, then the driver type name is not supported. Consult your driver documentation for a list of driver data types. Length specifiers are not included. Common type names include "VARCHAR", "TEXT", "NVARCHAR", "DECIMAL", "BOOL", "INT", and "BIGINT". ( ColumnType) DecimalSize() (precision int64, scale int64, ok bool) DecimalSize returns the scale and precision of a decimal type. ( ColumnType) DefaultValue() (value string, ok bool) DefaultValue returns the default value of current column. ( ColumnType) Length() (length int64, ok bool) Length returns the column type length for variable length column types ( ColumnType) Name() string Name returns the name or alias of the column. ( ColumnType) Nullable() (nullable bool, ok bool) Nullable reports whether the column may be null. ( ColumnType) PrimaryKey() (isPrimaryKey bool, ok bool) PrimaryKey returns the column is primary key or not. ( ColumnType) ScanType() reflect.Type ScanType returns a Go type suitable for scanning into using Rows.Scan. ( ColumnType) Unique() (unique bool, ok bool) Unique reports whether the column may be unique. Implements (at least one exported) ColumnType : gorm.io/gorm.ColumnType

type Config (struct) Config schema config Fields (total 3) CreateIndexAfterCreateTable bool DB *gorm.DB Dialector gorm.Dialector Methods (total 8) ( Config) BindVarTo(writer clause.Writer, stmt *gorm.Statement, v interface{}) ( Config) DataTypeOf(*schema.Field) string ( Config) DefaultValueOf(*schema.Field) clause.Expression ( Config) Explain(sql string, vars ...interface{}) string ( Config) Initialize(*gorm.DB) error ( Config) Migrator(db *gorm.DB) gorm.Migrator ( Config) Name() string ( Config) QuoteTo(clause.Writer, string) Implements (at least 2) Config : gorm.io/gorm.Dialector Config : gorm.io/gorm.Plugin

type GormDataTypeInterface (interface) GormDataTypeInterface gorm data type interface Methods (only one) ( GormDataTypeInterface) GormDBDataType(*gorm.DB, *schema.Field) string

type Index (struct) Index implements gorm.Index interface Fields (total 6) ColumnList []string NameValue string OptionValue string PrimaryKeyValue sql.NullBool TableName string UniqueValue sql.NullBool Methods (total 6) ( Index) Columns() []string Columns return the columns of the index ( Index) Name() string Name return the name of the index. ( Index) Option() string Option return the optional attribute of the index ( Index) PrimaryKey() (isPrimaryKey bool, ok bool) PrimaryKey returns the index is primary key or not. ( Index) Table() string Table return the table name of the index. ( Index) Unique() (unique bool, ok bool) Unique returns whether the index is unique or not. Implements (at least one exported) Index : gorm.io/gorm.Index

type Migrator (struct) Migrator m struct Fields (total 4) Config Config Config.CreateIndexAfterCreateTable bool Config.DB *gorm.DB Config.Dialector gorm.Dialector Methods (total 40) ( Migrator) AddColumn(value interface{}, name string) error AddColumn create `name` column for value ( Migrator) AlterColumn(value interface{}, field string) error AlterColumn alter value's `field` column' type based on schema definition ( Migrator) AutoMigrate(values ...interface{}) error AutoMigrate auto migrate values ( Migrator) BindVarTo(writer clause.Writer, stmt *gorm.Statement, v interface{}) ( Migrator) BuildIndexOptions(opts []schema.IndexOption, stmt *gorm.Statement) (results []interface{}) BuildIndexOptions build index options ( Migrator) ColumnTypes(value interface{}) ([]gorm.ColumnType, error) ColumnTypes return columnTypes []gorm.ColumnType and execErr error ( Migrator) CreateConstraint(value interface{}, name string) error CreateConstraint create constraint ( Migrator) CreateIndex(value interface{}, name string) error CreateIndex create index `name` ( Migrator) CreateTable(values ...interface{}) error CreateTable create table in database for values ( Migrator) CreateView(name string, option gorm.ViewOption) error CreateView create view from Query in gorm.ViewOption. Query in gorm.ViewOption is a [subquery] // CREATE VIEW `user_view` AS SELECT * FROM `users` WHERE age > 20 q := DB.Model(&User{}).Where("age > ?", 20) DB.Debug().Migrator().CreateView("user_view", gorm.ViewOption{Query: q}) // CREATE OR REPLACE VIEW `users_view` AS SELECT * FROM `users` WITH CHECK OPTION q := DB.Model(&User{}) DB.Debug().Migrator().CreateView("user_view", gorm.ViewOption{Query: q, Replace: true, CheckOption: "WITH CHECK OPTION"}) [subquery]: https://gorm.io/docs/advanced_query.html#SubQuery ( Migrator) CurrentDatabase() (name string) CurrentDatabase returns current database name ( Migrator) CurrentTable(stmt *gorm.Statement) interface{} CurrentTable returns current statement's table expression ( Migrator) DataTypeOf(field *schema.Field) string DataTypeOf return field's db data type ( Migrator) DefaultValueOf(*schema.Field) clause.Expression ( Migrator) DropColumn(value interface{}, name string) error DropColumn drop value's `name` column ( Migrator) DropConstraint(value interface{}, name string) error DropConstraint drop constraint ( Migrator) DropIndex(value interface{}, name string) error DropIndex drop index `name` ( Migrator) DropTable(values ...interface{}) error DropTable drop table for values ( Migrator) DropView(name string) error DropView drop view ( Migrator) Explain(sql string, vars ...interface{}) string ( Migrator) FullDataTypeOf(field *schema.Field) (expr clause.Expr) FullDataTypeOf returns field's db full data type ( Migrator) GetIndexes(dst interface{}) ([]gorm.Index, error) GetIndexes return Indexes []gorm.Index and execErr error ( Migrator) GetTables() (tableList []string, err error) GetTables returns tables ( Migrator) GetTypeAliases(databaseTypeName string) []string GetTypeAliases return database type aliases ( Migrator) GuessConstraintAndTable(stmt *gorm.Statement, name string) (_ *schema.Constraint, _ *schema.Check, table string) GuessConstraintAndTable guess statement's constraint and it's table based on name ( Migrator) HasColumn(value interface{}, field string) bool HasColumn check has column `field` for value or not ( Migrator) HasConstraint(value interface{}, name string) bool HasConstraint check has constraint or not ( Migrator) HasIndex(value interface{}, name string) bool HasIndex check has index `name` or not ( Migrator) HasTable(value interface{}) bool HasTable returns table exists or not for value, value could be a struct or string ( Migrator) Initialize(*gorm.DB) error ( Migrator) MigrateColumn(value interface{}, field *schema.Field, columnType gorm.ColumnType) error MigrateColumn migrate column ( Migrator) Migrator(db *gorm.DB) gorm.Migrator ( Migrator) Name() string ( Migrator) QuoteTo(clause.Writer, string) ( Migrator) RenameColumn(value interface{}, oldName, newName string) error RenameColumn rename value's field name from oldName to newName ( Migrator) RenameIndex(value interface{}, oldName, newName string) error RenameIndex rename index from oldName to newName ( Migrator) RenameTable(oldName, newName interface{}) error RenameTable rename table from oldName to newName ( Migrator) ReorderModels(values []interface{}, autoAdd bool) (results []interface{}) ReorderModels reorder models according to constraint dependencies ( Migrator) RunWithValue(value interface{}, fc func(*gorm.Statement) error) error RunWithValue run migration with statement value ( Migrator) TableType(dst interface{}) (gorm.TableType, error) TableType return tableType gorm.TableType and execErr error Implements (at least 4) Migrator : BuildIndexOptionsInterface Migrator : gorm.io/gorm.Dialector Migrator : gorm.io/gorm.Migrator Migrator : gorm.io/gorm.Plugin

type TableType (struct) TableType table type implements TableType interface Fields (total 4) CommentValue sql.NullString NameValue string SchemaValue string TypeValue string Methods (total 4) ( TableType) Comment() (comment string, ok bool) Comment returns the comment of current table. ( TableType) Name() string Name returns the name of the table. ( TableType) Schema() string Schema returns the schema of the table. ( TableType) Type() string Type returns the type of the table. Implements (at least one exported) TableType : gorm.io/gorm.TableType