migrate

Documentation

Index

• Variables
• func Create(ctx context.Context, s *Schema, tables []*schema.Table, ...) error
• type Schema
  • func NewSchema(drv dialect.Driver) *Schema
  • func (s *Schema) Create(ctx context.Context, opts ...schema.MigrateOption) error
  • func (s *Schema) WriteTo(ctx context.Context, w io.Writer, opts ...schema.MigrateOption) error

Variables

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
)

var (
	// GuildsColumns holds the columns for the "guilds" table.
	GuildsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeUint64, Increment: true},
		{Name: "name", Type: field.TypeString},
		{Name: "icon_hash", Type: field.TypeString, Nullable: true},
		{Name: "audit_channel", Type: field.TypeUint64, Unique: true, Nullable: true},
		{Name: "language", Type: field.TypeEnum, Enums: []string{"en-US"}, Default: "en-US"},
		{Name: "admin_snowflakes", Type: field.TypeJSON},
		{Name: "moderator_snowflakes", Type: field.TypeJSON, Nullable: true},
		{Name: "settings", Type: field.TypeJSON, Nullable: true},
	}
	// GuildsTable holds the schema information for the "guilds" table.
	GuildsTable = &schema.Table{
		Name:       "guilds",
		Columns:    GuildsColumns,
		PrimaryKey: []*schema.Column{GuildsColumns[0]},
	}
	// GuildRolesColumns holds the columns for the "guild_roles" table.
	GuildRolesColumns = []*schema.Column{
		{Name: "id", Type: field.TypeUint64, Increment: true},
		{Name: "name", Type: field.TypeString},
		{Name: "last_updated", Type: field.TypeTime},
		{Name: "guild_roles", Type: field.TypeUint64},
		{Name: "you_tube_talent_roles", Type: field.TypeString, Nullable: true},
	}
	// GuildRolesTable holds the schema information for the "guild_roles" table.
	GuildRolesTable = &schema.Table{
		Name:       "guild_roles",
		Columns:    GuildRolesColumns,
		PrimaryKey: []*schema.Column{GuildRolesColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "guild_roles_guilds_roles",
				Columns:    []*schema.Column{GuildRolesColumns[3]},
				RefColumns: []*schema.Column{GuildsColumns[0]},
				OnDelete:   schema.NoAction,
			},
			{
				Symbol:     "guild_roles_you_tube_talents_roles",
				Columns:    []*schema.Column{GuildRolesColumns[4]},
				RefColumns: []*schema.Column{YouTubeTalentsColumns[0]},
				OnDelete:   schema.SetNull,
			},
		},
		Indexes: []*schema.Index{
			{
				Name:    "guild_talent",
				Unique:  true,
				Columns: []*schema.Column{GuildRolesColumns[3], GuildRolesColumns[4]},
			},
		},
	}
	// UsersColumns holds the columns for the "users" table.
	UsersColumns = []*schema.Column{
		{Name: "id", Type: field.TypeUint64, Increment: true},
		{Name: "full_name", Type: field.TypeString},
		{Name: "avatar_hash", Type: field.TypeString},
		{Name: "last_check", Type: field.TypeTime},
		{Name: "youtube_id", Type: field.TypeString, Unique: true, Nullable: true},
		{Name: "youtube_token", Type: field.TypeJSON, Nullable: true},
		{Name: "discord_token", Type: field.TypeJSON, Nullable: true},
	}
	// UsersTable holds the schema information for the "users" table.
	UsersTable = &schema.Table{
		Name:       "users",
		Columns:    UsersColumns,
		PrimaryKey: []*schema.Column{UsersColumns[0]},
	}
	// UserMembershipsColumns holds the columns for the "user_memberships" table.
	UserMembershipsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "first_failed", Type: field.TypeTime, Nullable: true},
		{Name: "last_verified", Type: field.TypeTime},
		{Name: "fail_count", Type: field.TypeInt, Default: 0},
		{Name: "user_memberships", Type: field.TypeUint64, Nullable: true},
		{Name: "user_membership_youtube_talent", Type: field.TypeString},
	}
	// UserMembershipsTable holds the schema information for the "user_memberships" table.
	UserMembershipsTable = &schema.Table{
		Name:       "user_memberships",
		Columns:    UserMembershipsColumns,
		PrimaryKey: []*schema.Column{UserMembershipsColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "user_memberships_users_memberships",
				Columns:    []*schema.Column{UserMembershipsColumns[4]},
				RefColumns: []*schema.Column{UsersColumns[0]},
				OnDelete:   schema.Cascade,
			},
			{
				Symbol:     "user_memberships_you_tube_talents_youtube_talent",
				Columns:    []*schema.Column{UserMembershipsColumns[5]},
				RefColumns: []*schema.Column{YouTubeTalentsColumns[0]},
				OnDelete:   schema.Cascade,
			},
		},
	}
	// YouTubeTalentsColumns holds the columns for the "you_tube_talents" table.
	YouTubeTalentsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeString, Unique: true},
		{Name: "channel_name", Type: field.TypeString},
		{Name: "thumbnail_url", Type: field.TypeString},
		{Name: "membership_video_id", Type: field.TypeString, Nullable: true},
		{Name: "last_membership_video_id_miss", Type: field.TypeTime, Nullable: true},
		{Name: "last_updated", Type: field.TypeTime},
		{Name: "disabled", Type: field.TypeTime, Nullable: true},
		{Name: "disabled_permanently", Type: field.TypeBool, Default: false},
	}
	// YouTubeTalentsTable holds the schema information for the "you_tube_talents" table.
	YouTubeTalentsTable = &schema.Table{
		Name:       "you_tube_talents",
		Columns:    YouTubeTalentsColumns,
		PrimaryKey: []*schema.Column{YouTubeTalentsColumns[0]},
	}
	// GuildMembersColumns holds the columns for the "guild_members" table.
	GuildMembersColumns = []*schema.Column{
		{Name: "guild_id", Type: field.TypeUint64},
		{Name: "user_id", Type: field.TypeUint64},
	}
	// GuildMembersTable holds the schema information for the "guild_members" table.
	GuildMembersTable = &schema.Table{
		Name:       "guild_members",
		Columns:    GuildMembersColumns,
		PrimaryKey: []*schema.Column{GuildMembersColumns[0], GuildMembersColumns[1]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "guild_members_guild_id",
				Columns:    []*schema.Column{GuildMembersColumns[0]},
				RefColumns: []*schema.Column{GuildsColumns[0]},
				OnDelete:   schema.Cascade,
			},
			{
				Symbol:     "guild_members_user_id",
				Columns:    []*schema.Column{GuildMembersColumns[1]},
				RefColumns: []*schema.Column{UsersColumns[0]},
				OnDelete:   schema.Cascade,
			},
		},
	}
	// GuildAdminsColumns holds the columns for the "guild_admins" table.
	GuildAdminsColumns = []*schema.Column{
		{Name: "guild_id", Type: field.TypeUint64},
		{Name: "user_id", Type: field.TypeUint64},
	}
	// GuildAdminsTable holds the schema information for the "guild_admins" table.
	GuildAdminsTable = &schema.Table{
		Name:       "guild_admins",
		Columns:    GuildAdminsColumns,
		PrimaryKey: []*schema.Column{GuildAdminsColumns[0], GuildAdminsColumns[1]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "guild_admins_guild_id",
				Columns:    []*schema.Column{GuildAdminsColumns[0]},
				RefColumns: []*schema.Column{GuildsColumns[0]},
				OnDelete:   schema.Cascade,
			},
			{
				Symbol:     "guild_admins_user_id",
				Columns:    []*schema.Column{GuildAdminsColumns[1]},
				RefColumns: []*schema.Column{UsersColumns[0]},
				OnDelete:   schema.Cascade,
			},
		},
	}
	// UserMembershipRolesColumns holds the columns for the "user_membership_roles" table.
	UserMembershipRolesColumns = []*schema.Column{
		{Name: "user_membership_id", Type: field.TypeInt},
		{Name: "guild_role_id", Type: field.TypeUint64},
	}
	// UserMembershipRolesTable holds the schema information for the "user_membership_roles" table.
	UserMembershipRolesTable = &schema.Table{
		Name:       "user_membership_roles",
		Columns:    UserMembershipRolesColumns,
		PrimaryKey: []*schema.Column{UserMembershipRolesColumns[0], UserMembershipRolesColumns[1]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "user_membership_roles_user_membership_id",
				Columns:    []*schema.Column{UserMembershipRolesColumns[0]},
				RefColumns: []*schema.Column{UserMembershipsColumns[0]},
				OnDelete:   schema.Cascade,
			},
			{
				Symbol:     "user_membership_roles_guild_role_id",
				Columns:    []*schema.Column{UserMembershipRolesColumns[1]},
				RefColumns: []*schema.Column{GuildRolesColumns[0]},
				OnDelete:   schema.Cascade,
			},
		},
	}
	// YouTubeTalentGuildsColumns holds the columns for the "you_tube_talent_guilds" table.
	YouTubeTalentGuildsColumns = []*schema.Column{
		{Name: "you_tube_talent_id", Type: field.TypeString},
		{Name: "guild_id", Type: field.TypeUint64},
	}
	// YouTubeTalentGuildsTable holds the schema information for the "you_tube_talent_guilds" table.
	YouTubeTalentGuildsTable = &schema.Table{
		Name:       "you_tube_talent_guilds",
		Columns:    YouTubeTalentGuildsColumns,
		PrimaryKey: []*schema.Column{YouTubeTalentGuildsColumns[0], YouTubeTalentGuildsColumns[1]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "you_tube_talent_guilds_you_tube_talent_id",
				Columns:    []*schema.Column{YouTubeTalentGuildsColumns[0]},
				RefColumns: []*schema.Column{YouTubeTalentsColumns[0]},
				OnDelete:   schema.Cascade,
			},
			{
				Symbol:     "you_tube_talent_guilds_guild_id",
				Columns:    []*schema.Column{YouTubeTalentGuildsColumns[1]},
				RefColumns: []*schema.Column{GuildsColumns[0]},
				OnDelete:   schema.Cascade,
			},
		},
	}
	// Tables holds all the tables in the schema.
	Tables = []*schema.Table{
		GuildsTable,
		GuildRolesTable,
		UsersTable,
		UserMembershipsTable,
		YouTubeTalentsTable,
		GuildMembersTable,
		GuildAdminsTable,
		UserMembershipRolesTable,
		YouTubeTalentGuildsTable,
	}
)

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 NewSchema

func NewSchema(drv dialect.Driver) *Schema

NewSchema creates a new schema client.

func (*Schema) Create

func (s *Schema) Create(ctx context.Context, opts ...schema.MigrateOption) error

Create creates all schema resources.

func (*Schema) WriteTo

func (s *Schema) WriteTo(ctx context.Context, w io.Writer, opts ...schema.MigrateOption) error

WriteTo writes the schema changes to w instead of running them against the database.

if err := client.Schema.WriteTo(context.Background(), os.Stdout); err != nil {
	log.Fatal(err)
}