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 ( // AdminUsersColumns holds the columns for the "admin_users" table. AdminUsersColumns = []*schema.Column{ {Name: "id", Type: field.TypeString}, {Name: "name", Type: field.TypeString, Nullable: true}, {Name: "email", Type: field.TypeString, Unique: true}, {Name: "password", Type: field.TypeString}, {Name: "first_name", Type: field.TypeString}, {Name: "last_name", Type: field.TypeString}, {Name: "created_at", Type: field.TypeTime, Nullable: true}, {Name: "updated_at", Type: field.TypeTime, Nullable: true}, {Name: "admin_user_admin_created_by", Type: field.TypeString, Nullable: true}, {Name: "admin_user_admin_updated_by", Type: field.TypeString, Nullable: true}, {Name: "admin_user_default_role", Type: field.TypeString, Nullable: true}, } // AdminUsersTable holds the schema information for the "admin_users" table. AdminUsersTable = &schema.Table{ Name: "admin_users", Columns: AdminUsersColumns, PrimaryKey: []*schema.Column{AdminUsersColumns[0]}, ForeignKeys: []*schema.ForeignKey{ { Symbol: "admin_users_admin_users_admin_created_by", Columns: []*schema.Column{AdminUsersColumns[8]}, RefColumns: []*schema.Column{AdminUsersColumns[0]}, OnDelete: schema.SetNull, }, { Symbol: "admin_users_admin_users_admin_updated_by", Columns: []*schema.Column{AdminUsersColumns[9]}, RefColumns: []*schema.Column{AdminUsersColumns[0]}, OnDelete: schema.SetNull, }, { Symbol: "admin_users_roles_default_role", Columns: []*schema.Column{AdminUsersColumns[10]}, RefColumns: []*schema.Column{RolesColumns[0]}, OnDelete: schema.SetNull, }, }, } // FilesColumns holds the columns for the "files" table. FilesColumns = []*schema.Column{ {Name: "id", Type: field.TypeString}, {Name: "created_at", Type: field.TypeTime, Nullable: true, SchemaType: map[string]string{"mysql": "datetime", "postgres": "timestamp"}}, {Name: "updated_at", Type: field.TypeTime, Nullable: true, SchemaType: map[string]string{"mysql": "datetime", "postgres": "timestamp"}}, {Name: "caption", Type: field.TypeString, Unique: true, Nullable: true, SchemaType: map[string]string{"mysql": "VARCHAR(255)", "postgres": "VARCHAR(255)"}}, {Name: "name", Type: field.TypeString, SchemaType: map[string]string{"mysql": "VARCHAR(255)", "postgres": "VARCHAR(255)"}}, {Name: "mime_type", Type: field.TypeString, SchemaType: map[string]string{"mysql": "VARCHAR(255)", "postgres": "VARCHAR(255)"}}, {Name: "storage_file_name", Type: field.TypeString, SchemaType: map[string]string{"mysql": "VARCHAR(255)", "postgres": "VARCHAR(255)"}}, {Name: "size", Type: field.TypeInt64}, {Name: "file_admin_created_by", Type: field.TypeString, Nullable: true}, {Name: "file_admin_updated_by", Type: field.TypeString, Nullable: true}, {Name: "file_created_by", Type: field.TypeString, Nullable: true}, {Name: "file_updated_by", Type: field.TypeString, Nullable: true}, } // FilesTable holds the schema information for the "files" table. FilesTable = &schema.Table{ Name: "files", Columns: FilesColumns, PrimaryKey: []*schema.Column{FilesColumns[0]}, ForeignKeys: []*schema.ForeignKey{ { Symbol: "files_admin_users_admin_created_by", Columns: []*schema.Column{FilesColumns[8]}, RefColumns: []*schema.Column{AdminUsersColumns[0]}, OnDelete: schema.SetNull, }, { Symbol: "files_admin_users_admin_updated_by", Columns: []*schema.Column{FilesColumns[9]}, RefColumns: []*schema.Column{AdminUsersColumns[0]}, OnDelete: schema.SetNull, }, { Symbol: "files_users_created_by", Columns: []*schema.Column{FilesColumns[10]}, RefColumns: []*schema.Column{UsersColumns[0]}, OnDelete: schema.SetNull, }, { Symbol: "files_users_updated_by", Columns: []*schema.Column{FilesColumns[11]}, RefColumns: []*schema.Column{UsersColumns[0]}, OnDelete: schema.SetNull, }, }, } // PermissionsColumns holds the columns for the "permissions" table. PermissionsColumns = []*schema.Column{ {Name: "id", Type: field.TypeString}, {Name: "created_at", Type: field.TypeTime, Nullable: true, SchemaType: map[string]string{"mysql": "datetime", "postgres": "timestamp"}}, {Name: "updated_at", Type: field.TypeTime, Nullable: true, SchemaType: map[string]string{"mysql": "datetime", "postgres": "timestamp"}}, {Name: "entity", Type: field.TypeString, SchemaType: map[string]string{"mysql": "VARCHAR(255)", "postgres": "VARCHAR(255)"}}, {Name: "operation", Type: field.TypeString, Default: ""}, {Name: "permission_admin_created_by", Type: field.TypeString, Nullable: true}, {Name: "permission_admin_updated_by", Type: field.TypeString, Nullable: true}, {Name: "permission_role", Type: field.TypeString, Nullable: true}, } // PermissionsTable holds the schema information for the "permissions" table. PermissionsTable = &schema.Table{ Name: "permissions", Columns: PermissionsColumns, PrimaryKey: []*schema.Column{PermissionsColumns[0]}, ForeignKeys: []*schema.ForeignKey{ { Symbol: "permissions_admin_users_admin_created_by", Columns: []*schema.Column{PermissionsColumns[5]}, RefColumns: []*schema.Column{AdminUsersColumns[0]}, OnDelete: schema.SetNull, }, { Symbol: "permissions_admin_users_admin_updated_by", Columns: []*schema.Column{PermissionsColumns[6]}, RefColumns: []*schema.Column{AdminUsersColumns[0]}, OnDelete: schema.SetNull, }, { Symbol: "permissions_roles_role", Columns: []*schema.Column{PermissionsColumns[7]}, RefColumns: []*schema.Column{RolesColumns[0]}, OnDelete: schema.SetNull, }, }, } // RolesColumns holds the columns for the "roles" table. RolesColumns = []*schema.Column{ {Name: "id", Type: field.TypeString}, {Name: "name", Type: field.TypeString, Unique: true}, {Name: "created_at", Type: field.TypeTime, Nullable: true}, {Name: "updated_at", Type: field.TypeTime, Nullable: true}, {Name: "role_admin_created_by", Type: field.TypeString, Nullable: true}, {Name: "role_admin_updated_by", Type: field.TypeString, Nullable: true}, } // RolesTable holds the schema information for the "roles" table. RolesTable = &schema.Table{ Name: "roles", Columns: RolesColumns, PrimaryKey: []*schema.Column{RolesColumns[0]}, ForeignKeys: []*schema.ForeignKey{ { Symbol: "roles_admin_users_admin_created_by", Columns: []*schema.Column{RolesColumns[4]}, RefColumns: []*schema.Column{AdminUsersColumns[0]}, OnDelete: schema.SetNull, }, { Symbol: "roles_admin_users_admin_updated_by", Columns: []*schema.Column{RolesColumns[5]}, RefColumns: []*schema.Column{AdminUsersColumns[0]}, OnDelete: schema.SetNull, }, }, } // UsersColumns holds the columns for the "users" table. UsersColumns = []*schema.Column{ {Name: "id", Type: field.TypeString}, {Name: "email", Type: field.TypeString, Unique: true}, {Name: "password", Type: field.TypeString}, {Name: "user_created_by", Type: field.TypeString, Nullable: true}, {Name: "user_updated_by", Type: field.TypeString, Nullable: true}, {Name: "user_admin_created_by", Type: field.TypeString, Nullable: true}, {Name: "user_admin_updated_by", Type: field.TypeString, Nullable: true}, {Name: "user_default_role", Type: field.TypeString, Nullable: true}, } // UsersTable holds the schema information for the "users" table. UsersTable = &schema.Table{ Name: "users", Columns: UsersColumns, PrimaryKey: []*schema.Column{UsersColumns[0]}, ForeignKeys: []*schema.ForeignKey{ { Symbol: "users_users_created_by", Columns: []*schema.Column{UsersColumns[3]}, RefColumns: []*schema.Column{UsersColumns[0]}, OnDelete: schema.SetNull, }, { Symbol: "users_users_updated_by", Columns: []*schema.Column{UsersColumns[4]}, RefColumns: []*schema.Column{UsersColumns[0]}, OnDelete: schema.SetNull, }, { Symbol: "users_admin_users_admin_created_by", Columns: []*schema.Column{UsersColumns[5]}, RefColumns: []*schema.Column{AdminUsersColumns[0]}, OnDelete: schema.SetNull, }, { Symbol: "users_admin_users_admin_updated_by", Columns: []*schema.Column{UsersColumns[6]}, RefColumns: []*schema.Column{AdminUsersColumns[0]}, OnDelete: schema.SetNull, }, { Symbol: "users_roles_default_role", Columns: []*schema.Column{UsersColumns[7]}, RefColumns: []*schema.Column{RolesColumns[0]}, OnDelete: schema.SetNull, }, }, } // AdminUserRolesColumns holds the columns for the "admin_user_roles" table. AdminUserRolesColumns = []*schema.Column{ {Name: "admin_user_id", Type: field.TypeString}, {Name: "role_id", Type: field.TypeString}, } // AdminUserRolesTable holds the schema information for the "admin_user_roles" table. AdminUserRolesTable = &schema.Table{ Name: "admin_user_roles", Columns: AdminUserRolesColumns, PrimaryKey: []*schema.Column{AdminUserRolesColumns[0], AdminUserRolesColumns[1]}, ForeignKeys: []*schema.ForeignKey{ { Symbol: "admin_user_roles_admin_user_id", Columns: []*schema.Column{AdminUserRolesColumns[0]}, RefColumns: []*schema.Column{AdminUsersColumns[0]}, OnDelete: schema.Cascade, }, { Symbol: "admin_user_roles_role_id", Columns: []*schema.Column{AdminUserRolesColumns[1]}, RefColumns: []*schema.Column{RolesColumns[0]}, OnDelete: schema.Cascade, }, }, } // UserRolesColumns holds the columns for the "user_roles" table. UserRolesColumns = []*schema.Column{ {Name: "user_id", Type: field.TypeString}, {Name: "role_id", Type: field.TypeString}, } // UserRolesTable holds the schema information for the "user_roles" table. UserRolesTable = &schema.Table{ Name: "user_roles", Columns: UserRolesColumns, PrimaryKey: []*schema.Column{UserRolesColumns[0], UserRolesColumns[1]}, ForeignKeys: []*schema.ForeignKey{ { Symbol: "user_roles_user_id", Columns: []*schema.Column{UserRolesColumns[0]}, RefColumns: []*schema.Column{UsersColumns[0]}, OnDelete: schema.Cascade, }, { Symbol: "user_roles_role_id", Columns: []*schema.Column{UserRolesColumns[1]}, RefColumns: []*schema.Column{RolesColumns[0]}, OnDelete: schema.Cascade, }, }, } // Tables holds all the tables in the schema. Tables = []*schema.Table{ AdminUsersTable, FilesTable, PermissionsTable, RolesTable, UsersTable, AdminUserRolesTable, UserRolesTable, } )
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.