Documentation ¶
Index ¶
- Variables
- func Create(ctx context.Context, s *Schema, tables []*schema.Table, ...) error
- func Diff(ctx context.Context, url string, opts ...schema.MigrateOption) error
- func NamedDiff(ctx context.Context, url, name string, opts ...schema.MigrateOption) error
- type Schema
- func (s *Schema) Create(ctx context.Context, opts ...schema.MigrateOption) error
- func (s *Schema) Diff(ctx context.Context, opts ...schema.MigrateOption) error
- func (s *Schema) NamedDiff(ctx context.Context, name string, opts ...schema.MigrateOption) error
- func (s *Schema) WriteTo(ctx context.Context, w io.Writer, opts ...schema.MigrateOption) error
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // WithGlobalUniqueID sets the universal ids options to the migration. // If this option is enabled, ent migration will allocate a 1<<32 range // for the ids of each entity (table). // Note that this option cannot be applied on tables that already exist. WithGlobalUniqueID = schema.WithGlobalUniqueID // WithDropColumn sets the drop column option to the migration. // If this option is enabled, ent migration will drop old columns // that were used for both fields and edges. This defaults to false. WithDropColumn = schema.WithDropColumn // WithDropIndex sets the drop index option to the migration. // If this option is enabled, ent migration will drop old indexes // that were defined in the schema. This defaults to false. // Note that unique constraints are defined using `UNIQUE INDEX`, // and therefore, it's recommended to enable this option to get more // flexibility in the schema changes. WithDropIndex = schema.WithDropIndex // WithForeignKeys enables creating foreign-key in schema DDL. This defaults to true. WithForeignKeys = schema.WithForeignKeys )
View Source
var ( // LocationColumns holds the columns for the "location" table. LocationColumns = []*schema.Column{ {Name: "id", Type: field.TypeInt, Increment: true}, {Name: "name", Type: field.TypeString, Size: 2048}, {Name: "description", Type: field.TypeString, Size: 2048}, {Name: "source", Type: field.TypeEnum, Enums: []string{"unspecified", "minio", "sftp", "amss"}}, {Name: "purpose", Type: field.TypeEnum, Enums: []string{"unspecified", "aip_store"}}, {Name: "uuid", Type: field.TypeUUID, Unique: true}, {Name: "config", Type: field.TypeJSON}, {Name: "created_at", Type: field.TypeTime}, } // LocationTable holds the schema information for the "location" table. LocationTable = &schema.Table{ Name: "location", Columns: LocationColumns, PrimaryKey: []*schema.Column{LocationColumns[0]}, Indexes: []*schema.Index{ { Name: "location_name", Unique: false, Columns: []*schema.Column{LocationColumns[1]}, Annotation: &entsql.IndexAnnotation{ Prefix: 50, }, }, { Name: "location_uuid", Unique: false, Columns: []*schema.Column{LocationColumns[5]}, }, }, } // PackageColumns holds the columns for the "package" table. PackageColumns = []*schema.Column{ {Name: "id", Type: field.TypeInt, Increment: true}, {Name: "name", Type: field.TypeString, Size: 2048}, {Name: "aip_id", Type: field.TypeUUID, Unique: true}, {Name: "status", Type: field.TypeEnum, Enums: []string{"unspecified", "in_review", "rejected", "stored", "moving"}}, {Name: "object_key", Type: field.TypeUUID, Unique: true}, {Name: "created_at", Type: field.TypeTime}, {Name: "location_id", Type: field.TypeInt, Nullable: true}, } // PackageTable holds the schema information for the "package" table. PackageTable = &schema.Table{ Name: "package", Columns: PackageColumns, PrimaryKey: []*schema.Column{PackageColumns[0]}, ForeignKeys: []*schema.ForeignKey{ { Symbol: "package_location_location", Columns: []*schema.Column{PackageColumns[6]}, RefColumns: []*schema.Column{LocationColumns[0]}, OnDelete: schema.SetNull, }, }, Indexes: []*schema.Index{ { Name: "pkg_aip_id", Unique: false, Columns: []*schema.Column{PackageColumns[2]}, }, { Name: "pkg_object_key", Unique: false, Columns: []*schema.Column{PackageColumns[4]}, }, }, } // Tables holds all the tables in the schema. Tables = []*schema.Table{ LocationTable, PackageTable, } )
Functions ¶
func Create ¶
func Create(ctx context.Context, s *Schema, tables []*schema.Table, opts ...schema.MigrateOption) error
Create creates all table resources using the given schema driver.
Types ¶
type Schema ¶
type Schema struct {
// contains filtered or unexported fields
}
Schema is the API for creating, migrating and dropping a schema.
func (*Schema) Diff ¶
Diff creates a migration file containing the statements to resolve the diff between the Ent schema and the connected database.
func (*Schema) NamedDiff ¶
NamedDiff creates a named migration file containing the statements to resolve the diff between the Ent schema and the connected database.
Click to show internal directories.
Click to hide internal directories.