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 ( // GroupsColumns holds the columns for the "groups" table. GroupsColumns = []*schema.Column{ {Name: "id", Type: field.TypeUUID}, {Name: "created_at", Type: field.TypeTime}, {Name: "updated_at", Type: field.TypeTime}, } // GroupsTable holds the schema information for the "groups" table. GroupsTable = &schema.Table{ Name: "groups", Columns: GroupsColumns, PrimaryKey: []*schema.Column{GroupsColumns[0]}, } // MessagesColumns holds the columns for the "messages" table. MessagesColumns = []*schema.Column{ {Name: "id", Type: field.TypeUUID}, {Name: "created_at", Type: field.TypeTime}, {Name: "updated_at", Type: field.TypeTime}, {Name: "body", Type: field.TypeString}, } // MessagesTable holds the schema information for the "messages" table. MessagesTable = &schema.Table{ Name: "messages", Columns: MessagesColumns, PrimaryKey: []*schema.Column{MessagesColumns[0]}, } // NotificationsColumns holds the columns for the "notifications" table. NotificationsColumns = []*schema.Column{ {Name: "id", Type: field.TypeUUID}, {Name: "created_at", Type: field.TypeTime}, {Name: "updated_at", Type: field.TypeTime}, } // NotificationsTable holds the schema information for the "notifications" table. NotificationsTable = &schema.Table{ Name: "notifications", Columns: NotificationsColumns, PrimaryKey: []*schema.Column{NotificationsColumns[0]}, } // PostsColumns holds the columns for the "posts" table. PostsColumns = []*schema.Column{ {Name: "id", Type: field.TypeUUID}, {Name: "created_at", Type: field.TypeTime}, {Name: "updated_at", Type: field.TypeTime}, {Name: "user_posts", Type: field.TypeUUID, Nullable: true}, } // PostsTable holds the schema information for the "posts" table. PostsTable = &schema.Table{ Name: "posts", Columns: PostsColumns, PrimaryKey: []*schema.Column{PostsColumns[0]}, ForeignKeys: []*schema.ForeignKey{ { Symbol: "posts_users_posts", Columns: []*schema.Column{PostsColumns[3]}, RefColumns: []*schema.Column{UsersColumns[0]}, OnDelete: schema.SetNull, }, }, } // SettingsColumns holds the columns for the "settings" table. SettingsColumns = []*schema.Column{ {Name: "id", Type: field.TypeUUID}, {Name: "created_at", Type: field.TypeTime}, {Name: "updated_at", Type: field.TypeTime}, } // SettingsTable holds the schema information for the "settings" table. SettingsTable = &schema.Table{ Name: "settings", Columns: SettingsColumns, PrimaryKey: []*schema.Column{SettingsColumns[0]}, } // UsersColumns holds the columns for the "users" table. UsersColumns = []*schema.Column{ {Name: "id", Type: field.TypeUUID}, {Name: "created_at", Type: field.TypeTime}, {Name: "updated_at", Type: field.TypeTime}, {Name: "first_name", Type: field.TypeString}, {Name: "last_name", Type: field.TypeString}, {Name: "email_address", Type: field.TypeString, Unique: true}, {Name: "account_address", Type: field.TypeString, Unique: true}, {Name: "alias", Type: field.TypeString, Unique: true}, {Name: "bio", 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]}, } // GroupUsersColumns holds the columns for the "group_users" table. GroupUsersColumns = []*schema.Column{ {Name: "group_id", Type: field.TypeUUID}, {Name: "user_id", Type: field.TypeUUID}, } // GroupUsersTable holds the schema information for the "group_users" table. GroupUsersTable = &schema.Table{ Name: "group_users", Columns: GroupUsersColumns, PrimaryKey: []*schema.Column{GroupUsersColumns[0], GroupUsersColumns[1]}, ForeignKeys: []*schema.ForeignKey{ { Symbol: "group_users_group_id", Columns: []*schema.Column{GroupUsersColumns[0]}, RefColumns: []*schema.Column{GroupsColumns[0]}, OnDelete: schema.Cascade, }, { Symbol: "group_users_user_id", Columns: []*schema.Column{GroupUsersColumns[1]}, RefColumns: []*schema.Column{UsersColumns[0]}, OnDelete: schema.Cascade, }, }, } // MessageToColumns holds the columns for the "message_to" table. MessageToColumns = []*schema.Column{ {Name: "message_id", Type: field.TypeUUID}, {Name: "from_id", Type: field.TypeUUID}, } // MessageToTable holds the schema information for the "message_to" table. MessageToTable = &schema.Table{ Name: "message_to", Columns: MessageToColumns, PrimaryKey: []*schema.Column{MessageToColumns[0], MessageToColumns[1]}, ForeignKeys: []*schema.ForeignKey{ { Symbol: "message_to_message_id", Columns: []*schema.Column{MessageToColumns[0]}, RefColumns: []*schema.Column{MessagesColumns[0]}, OnDelete: schema.Cascade, }, { Symbol: "message_to_from_id", Columns: []*schema.Column{MessageToColumns[1]}, RefColumns: []*schema.Column{MessagesColumns[0]}, OnDelete: schema.Cascade, }, }, } // UserFollowingColumns holds the columns for the "user_following" table. UserFollowingColumns = []*schema.Column{ {Name: "user_id", Type: field.TypeUUID}, {Name: "follower_id", Type: field.TypeUUID}, } // UserFollowingTable holds the schema information for the "user_following" table. UserFollowingTable = &schema.Table{ Name: "user_following", Columns: UserFollowingColumns, PrimaryKey: []*schema.Column{UserFollowingColumns[0], UserFollowingColumns[1]}, ForeignKeys: []*schema.ForeignKey{ { Symbol: "user_following_user_id", Columns: []*schema.Column{UserFollowingColumns[0]}, RefColumns: []*schema.Column{UsersColumns[0]}, OnDelete: schema.Cascade, }, { Symbol: "user_following_follower_id", Columns: []*schema.Column{UserFollowingColumns[1]}, RefColumns: []*schema.Column{UsersColumns[0]}, OnDelete: schema.Cascade, }, }, } // Tables holds all the tables in the schema. Tables = []*schema.Table{ GroupsTable, MessagesTable, NotificationsTable, PostsTable, SettingsTable, UsersTable, GroupUsersTable, MessageToTable, UserFollowingTable, } )
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.