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 (
	// DchatsColumns holds the columns for the "dchats" table.
	DchatsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeString},
		{Name: "session_id", Type: field.TypeString},
		{Name: "user_id", Type: field.TypeString},
		{Name: "room_id", Type: field.TypeString},
		{Name: "text", Type: field.TypeString},
		{Name: "create_time", Type: field.TypeTime},
	}
	// DchatsTable holds the schema information for the "dchats" table.
	DchatsTable = &schema.Table{
		Name:       "dchats",
		Columns:    DchatsColumns,
		PrimaryKey: []*schema.Column{DchatsColumns[0]},
	}
	// DchessdbCachesColumns holds the columns for the "dchessdb_caches" table.
	DchessdbCachesColumns = []*schema.Column{
		{Name: "id", Type: field.TypeString},
		{Name: "board", Type: field.TypeString, Unique: true},
		{Name: "resp", Type: field.TypeBytes},
		{Name: "create_time", Type: field.TypeTime},
	}
	// DchessdbCachesTable holds the schema information for the "dchessdb_caches" table.
	DchessdbCachesTable = &schema.Table{
		Name:       "dchessdb_caches",
		Columns:    DchessdbCachesColumns,
		PrimaryKey: []*schema.Column{DchessdbCachesColumns[0]},
	}
	// DroomsColumns holds the columns for the "drooms" table.
	DroomsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeString},
		{Name: "is_game_running", Type: field.TypeBool, Nullable: true, Default: false},
		{Name: "panel", Type: field.TypeString, Nullable: true, Default: ""},
		{Name: "w_user_id", Type: field.TypeString, Nullable: true, Default: ""},
		{Name: "b_user_id", Type: field.TypeString, Nullable: true, Default: ""},
		{Name: "create_time", Type: field.TypeTime},
	}
	// DroomsTable holds the schema information for the "drooms" table.
	DroomsTable = &schema.Table{
		Name:       "drooms",
		Columns:    DroomsColumns,
		PrimaryKey: []*schema.Column{DroomsColumns[0]},
	}
	// DsessionsColumns holds the columns for the "dsessions" table.
	DsessionsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeString},
		{Name: "user_id", Type: field.TypeString, Default: ""},
		{Name: "room_id", Type: field.TypeString, Default: ""},
		{Name: "create_time", Type: field.TypeTime},
	}
	// DsessionsTable holds the schema information for the "dsessions" table.
	DsessionsTable = &schema.Table{
		Name:       "dsessions",
		Columns:    DsessionsColumns,
		PrimaryKey: []*schema.Column{DsessionsColumns[0]},
	}
	// DusersColumns holds the columns for the "dusers" table.
	DusersColumns = []*schema.Column{
		{Name: "id", Type: field.TypeString},
		{Name: "name", Type: field.TypeString, Unique: true},
		{Name: "password_hash", Type: field.TypeString},
		{Name: "create_time", Type: field.TypeTime},
	}
	// DusersTable holds the schema information for the "dusers" table.
	DusersTable = &schema.Table{
		Name:       "dusers",
		Columns:    DusersColumns,
		PrimaryKey: []*schema.Column{DusersColumns[0]},
	}
	// Tables holds all the tables in the schema.
	Tables = []*schema.Table{
		DchatsTable,
		DchessdbCachesTable,
		DroomsTable,
		DsessionsTable,
		DusersTable,
	}
)

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