migrate

Documentation

Index

• Variables
• 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
	// WithFixture sets the foreign-key renaming option to the migration when upgrading
	// ent from v0.1.0 (issue-#285). Defaults to false.
	WithFixture = schema.WithFixture
	// WithForeignKeys enables creating foreign-key in schema DDL. This defaults to true.
	WithForeignKeys = schema.WithForeignKeys
)

var (
	// CharactersColumns holds the columns for the "characters" table.
	CharactersColumns = []*schema.Column{
		{Name: "id", Type: field.TypeUUID},
		{Name: "created_at", Type: field.TypeTime},
		{Name: "updated_at", Type: field.TypeTime},
		{Name: "version", Type: field.TypeInt},
		{Name: "slot", Type: field.TypeInt, Default: 0},
		{Name: "size", Type: field.TypeInt, Default: 0},
		{Name: "data", Type: field.TypeString, SchemaType: map[string]string{"sqlite3": "text"}},
		{Name: "deleted_at", Type: field.TypeTime, Nullable: true},
		{Name: "player_id", Type: field.TypeUUID},
	}
	// CharactersTable holds the schema information for the "characters" table.
	CharactersTable = &schema.Table{
		Name:       "characters",
		Columns:    CharactersColumns,
		PrimaryKey: []*schema.Column{CharactersColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "characters_players_characters",
				Columns:    []*schema.Column{CharactersColumns[8]},
				RefColumns: []*schema.Column{PlayersColumns[0]},
				OnDelete:   schema.NoAction,
			},
		},
		Indexes: []*schema.Index{
			{
				Name:    "character_id",
				Unique:  true,
				Columns: []*schema.Column{CharactersColumns[0]},
			},
			{
				Name:    "character_player_id_slot_version",
				Unique:  true,
				Columns: []*schema.Column{CharactersColumns[8], CharactersColumns[4], CharactersColumns[3]},
			},
		},
	}
	// OldCharactersColumns holds the columns for the "old_characters" table.
	OldCharactersColumns = []*schema.Column{
		{Name: "id", Type: field.TypeUUID},
		{Name: "steamid", Type: field.TypeString},
		{Name: "slot", Type: field.TypeInt, Default: 0},
		{Name: "size", Type: field.TypeInt, Default: 0},
		{Name: "data", Type: field.TypeString, SchemaType: map[string]string{"sqlite3": "text"}},
	}
	// OldCharactersTable holds the schema information for the "old_characters" table.
	OldCharactersTable = &schema.Table{
		Name:       "old_characters",
		Columns:    OldCharactersColumns,
		PrimaryKey: []*schema.Column{OldCharactersColumns[0]},
		Indexes: []*schema.Index{
			{
				Name:    "deprecatedcharacter_id",
				Unique:  true,
				Columns: []*schema.Column{OldCharactersColumns[0]},
			},
			{
				Name:    "deprecatedcharacter_steamid_slot",
				Unique:  false,
				Columns: []*schema.Column{OldCharactersColumns[1], OldCharactersColumns[2]},
			},
		},
	}
	// PlayersColumns holds the columns for the "players" table.
	PlayersColumns = []*schema.Column{
		{Name: "id", Type: field.TypeUUID},
		{Name: "created_at", Type: field.TypeTime},
		{Name: "updated_at", Type: field.TypeTime},
		{Name: "steamid", Type: field.TypeString},
	}
	// PlayersTable holds the schema information for the "players" table.
	PlayersTable = &schema.Table{
		Name:       "players",
		Columns:    PlayersColumns,
		PrimaryKey: []*schema.Column{PlayersColumns[0]},
		Indexes: []*schema.Index{
			{
				Name:    "player_id",
				Unique:  true,
				Columns: []*schema.Column{PlayersColumns[0]},
			},
			{
				Name:    "player_steamid",
				Unique:  true,
				Columns: []*schema.Column{PlayersColumns[3]},
			},
		},
	}
	// Tables holds all the tables in the schema.
	Tables = []*schema.Table{
		CharactersTable,
		OldCharactersTable,
		PlayersTable,
	}
)

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