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 (
	// MatchesColumns holds the columns for the "matches" table.
	MatchesColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "match_hash", Type: field.TypeString, Unique: true},
		{Name: "version", Type: field.TypeInt},
		{Name: "season", Type: field.TypeInt8, Default: 0},
		{Name: "created_ts", Type: field.TypeTime},
		{Name: "turn_count", Type: field.TypeInt},
		{Name: "fetch_status", Type: field.TypeEnum, Enums: []string{"UNKNOWN", "LISTED", "FETCHED", "UNWRAPPED", "CONVERTED", "CANONICAL", "VALIDATED", "INDEXED", "INVALID", "LEGACY"}, Default: "LISTED"},
		{Name: "osn_map_matches", Type: field.TypeInt, Nullable: true},
	}
	// MatchesTable holds the schema information for the "matches" table.
	MatchesTable = &schema.Table{
		Name:       "matches",
		Columns:    MatchesColumns,
		PrimaryKey: []*schema.Column{MatchesColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "matches_osn_maps_matches",
				Columns:    []*schema.Column{MatchesColumns[7]},
				RefColumns: []*schema.Column{OsnMapsColumns[0]},
				OnDelete:   schema.SetNull,
			},
		},
	}
	// OsnMapsColumns holds the columns for the "osn_maps" table.
	OsnMapsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "name", Type: field.TypeString},
		{Name: "shortname", Type: field.TypeString},
		{Name: "role_count", Type: field.TypeInt},
	}
	// OsnMapsTable holds the schema information for the "osn_maps" table.
	OsnMapsTable = &schema.Table{
		Name:       "osn_maps",
		Columns:    OsnMapsColumns,
		PrimaryKey: []*schema.Column{OsnMapsColumns[0]},
	}
	// PlayersColumns holds the columns for the "players" table.
	PlayersColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "gcid", Type: field.TypeString, Unique: true},
		{Name: "name", Type: field.TypeString, Unique: true},
	}
	// PlayersTable holds the schema information for the "players" table.
	PlayersTable = &schema.Table{
		Name:       "players",
		Columns:    PlayersColumns,
		PrimaryKey: []*schema.Column{PlayersColumns[0]},
	}
	// PlayerRolesColumns holds the columns for the "player_roles" table.
	PlayerRolesColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "role_match", Type: field.TypeInt},
		{Name: "role_player", Type: field.TypeInt},
		{Name: "position", Type: field.TypeInt},
		{Name: "turn_order", Type: field.TypeInt},
	}
	// PlayerRolesTable holds the schema information for the "player_roles" table.
	PlayerRolesTable = &schema.Table{
		Name:       "player_roles",
		Columns:    PlayerRolesColumns,
		PrimaryKey: []*schema.Column{PlayerRolesColumns[0]},
		Indexes: []*schema.Index{
			{
				Name:    "playerrole_role_match_position",
				Unique:  true,
				Columns: []*schema.Column{PlayerRolesColumns[1], PlayerRolesColumns[3]},
			},
			{
				Name:    "playerrole_role_match_role_player",
				Unique:  true,
				Columns: []*schema.Column{PlayerRolesColumns[1], PlayerRolesColumns[2]},
			},
		},
	}
	// PlayerRoleMatchColumns holds the columns for the "player_role_match" table.
	PlayerRoleMatchColumns = []*schema.Column{
		{Name: "role_match", Type: field.TypeInt},
		{Name: "id", Type: field.TypeInt},
	}
	// PlayerRoleMatchTable holds the schema information for the "player_role_match" table.
	PlayerRoleMatchTable = &schema.Table{
		Name:       "player_role_match",
		Columns:    PlayerRoleMatchColumns,
		PrimaryKey: []*schema.Column{PlayerRoleMatchColumns[0], PlayerRoleMatchColumns[1]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "player_role_match_role_match",
				Columns:    []*schema.Column{PlayerRoleMatchColumns[0]},
				RefColumns: []*schema.Column{PlayerRolesColumns[0]},
				OnDelete:   schema.Cascade,
			},
			{
				Symbol:     "player_role_match_id",
				Columns:    []*schema.Column{PlayerRoleMatchColumns[1]},
				RefColumns: []*schema.Column{MatchesColumns[0]},
				OnDelete:   schema.Cascade,
			},
		},
	}
	// PlayerRolePlayersColumns holds the columns for the "player_role_players" table.
	PlayerRolePlayersColumns = []*schema.Column{
		{Name: "role_player", Type: field.TypeInt},
		{Name: "id", Type: field.TypeInt},
	}
	// PlayerRolePlayersTable holds the schema information for the "player_role_players" table.
	PlayerRolePlayersTable = &schema.Table{
		Name:       "player_role_players",
		Columns:    PlayerRolePlayersColumns,
		PrimaryKey: []*schema.Column{PlayerRolePlayersColumns[0], PlayerRolePlayersColumns[1]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "player_role_players_role_player",
				Columns:    []*schema.Column{PlayerRolePlayersColumns[0]},
				RefColumns: []*schema.Column{PlayerRolesColumns[0]},
				OnDelete:   schema.Cascade,
			},
			{
				Symbol:     "player_role_players_id",
				Columns:    []*schema.Column{PlayerRolePlayersColumns[1]},
				RefColumns: []*schema.Column{PlayersColumns[0]},
				OnDelete:   schema.Cascade,
			},
		},
	}
	// Tables holds all the tables in the schema.
	Tables = []*schema.Table{
		MatchesTable,
		OsnMapsTable,
		PlayersTable,
		PlayerRolesTable,
		PlayerRoleMatchTable,
		PlayerRolePlayersTable,
	}
)

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)
}