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 (
	// TestAColumns holds the columns for the "test_a" table.
	TestAColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "name", Type: field.TypeString},
		{Name: "int4", Type: field.TypeInt32},
		{Name: "int8", Type: field.TypeInt},
		{Name: "float4", Type: field.TypeFloat32},
		{Name: "float8", Type: field.TypeFloat64},
		{Name: "bool", Type: field.TypeBool},
		{Name: "text", Type: field.TypeString},
		{Name: "time", Type: field.TypeTime},
	}
	// TestATable holds the schema information for the "test_a" table.
	TestATable = &schema.Table{
		Name:       "test_a",
		Columns:    TestAColumns,
		PrimaryKey: []*schema.Column{TestAColumns[0]},
	}
	// TestBColumns holds the columns for the "test_b" table.
	TestBColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "name", Type: field.TypeString},
		{Name: "int4", Type: field.TypeInt32},
		{Name: "int8", Type: field.TypeInt},
		{Name: "float4", Type: field.TypeFloat32},
		{Name: "float8", Type: field.TypeFloat64},
		{Name: "bool", Type: field.TypeBool},
		{Name: "text", Type: field.TypeString},
		{Name: "time", Type: field.TypeTime},
		{Name: "a_id", Type: field.TypeInt, Nullable: true},
	}
	// TestBTable holds the schema information for the "test_b" table.
	TestBTable = &schema.Table{
		Name:       "test_b",
		Columns:    TestBColumns,
		PrimaryKey: []*schema.Column{TestBColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "test_b_test_a_test_bs",
				Columns:    []*schema.Column{TestBColumns[9]},
				RefColumns: []*schema.Column{TestAColumns[0]},
				OnDelete:   schema.SetNull,
			},
		},
	}
	// TestCColumns holds the columns for the "test_c" table.
	TestCColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "name", Type: field.TypeString},
		{Name: "int4", Type: field.TypeInt32},
		{Name: "int8", Type: field.TypeInt},
		{Name: "float4", Type: field.TypeFloat32},
		{Name: "float8", Type: field.TypeFloat64},
		{Name: "bool", Type: field.TypeBool},
		{Name: "text", Type: field.TypeString},
		{Name: "time", Type: field.TypeTime},
		{Name: "b_id", Type: field.TypeInt, Nullable: true},
	}
	// TestCTable holds the schema information for the "test_c" table.
	TestCTable = &schema.Table{
		Name:       "test_c",
		Columns:    TestCColumns,
		PrimaryKey: []*schema.Column{TestCColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "test_c_test_b_test_cs",
				Columns:    []*schema.Column{TestCColumns[9]},
				RefColumns: []*schema.Column{TestBColumns[0]},
				OnDelete:   schema.SetNull,
			},
		},
	}
	// Tables holds all the tables in the schema.
	Tables = []*schema.Table{
		TestATable,
		TestBTable,
		TestCTable,
	}
)

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