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 (
	// BreedsColumns holds the columns for the "breeds" table.
	BreedsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeUUID},
		{Name: "deleted_time", Type: field.TypeTime, Nullable: true},
		{Name: "create_time", Type: field.TypeTime},
		{Name: "update_time", Type: field.TypeTime},
		{Name: "name", Type: field.TypeString},
	}
	// BreedsTable holds the schema information for the "breeds" table.
	BreedsTable = &schema.Table{
		Name:       "breeds",
		Columns:    BreedsColumns,
		PrimaryKey: []*schema.Column{BreedsColumns[0]},
	}
	// CatsColumns holds the columns for the "cats" table.
	CatsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeUUID},
		{Name: "deleted_time", Type: field.TypeTime, Nullable: true},
		{Name: "create_time", Type: field.TypeTime},
		{Name: "update_time", Type: field.TypeTime},
		{Name: "name", Type: field.TypeString},
		{Name: "speed", Type: field.TypeInt64},
		{Name: "date_from", Type: field.TypeTime, SchemaType: map[string]string{"postgres": "date"}},
		{Name: "type", Type: field.TypeEnum, Enums: []string{"merch", "hotel", "tournament"}},
		{Name: "other_type", Type: field.TypeEnum, Enums: []string{"merch", "hotel", "tournament"}},
		{Name: "breed_id", Type: field.TypeUUID},
	}
	// CatsTable holds the schema information for the "cats" table.
	CatsTable = &schema.Table{
		Name:       "cats",
		Columns:    CatsColumns,
		PrimaryKey: []*schema.Column{CatsColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "cats_breeds_cats",
				Columns:    []*schema.Column{CatsColumns[9]},
				RefColumns: []*schema.Column{BreedsColumns[0]},
				OnDelete:   schema.NoAction,
			},
		},
	}
	// FatherCatsColumns holds the columns for the "father_cats" table.
	FatherCatsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeUUID},
		{Name: "deleted_time", Type: field.TypeTime, Nullable: true},
		{Name: "create_time", Type: field.TypeTime},
		{Name: "update_time", Type: field.TypeTime},
		{Name: "name", Type: field.TypeString},
	}
	// FatherCatsTable holds the schema information for the "father_cats" table.
	FatherCatsTable = &schema.Table{
		Name:       "father_cats",
		Columns:    FatherCatsColumns,
		PrimaryKey: []*schema.Column{FatherCatsColumns[0]},
	}
	// KittensColumns holds the columns for the "kittens" table.
	KittensColumns = []*schema.Column{
		{Name: "id", Type: field.TypeUUID},
		{Name: "deleted_time", Type: field.TypeTime, Nullable: true},
		{Name: "create_time", Type: field.TypeTime},
		{Name: "update_time", Type: field.TypeTime},
		{Name: "name", Type: field.TypeString},
		{Name: "mother_id", Type: field.TypeUUID},
	}
	// KittensTable holds the schema information for the "kittens" table.
	KittensTable = &schema.Table{
		Name:       "kittens",
		Columns:    KittensColumns,
		PrimaryKey: []*schema.Column{KittensColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "kittens_cats_kittens",
				Columns:    []*schema.Column{KittensColumns[5]},
				RefColumns: []*schema.Column{CatsColumns[0]},
				OnDelete:   schema.NoAction,
			},
		},
	}
	// Tables holds all the tables in the schema.
	Tables = []*schema.Table{
		BreedsTable,
		CatsTable,
		FatherCatsTable,
		KittensTable,
	}
)

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