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 (
	// UsersColumns holds the columns for the "users" table.
	UsersColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
	}
	// UsersTable holds the schema information for the "users" table.
	UsersTable = &schema.Table{
		Name:       "users",
		Columns:    UsersColumns,
		PrimaryKey: []*schema.Column{UsersColumns[0]},
	}
	// WithFieldsColumns holds the columns for the "with_fields" table.
	WithFieldsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "existing", Type: field.TypeString},
	}
	// WithFieldsTable holds the schema information for the "with_fields" table.
	WithFieldsTable = &schema.Table{
		Name:       "with_fields",
		Columns:    WithFieldsColumns,
		PrimaryKey: []*schema.Column{WithFieldsColumns[0]},
	}
	// WithModifiedFieldsColumns holds the columns for the "with_modified_fields" table.
	WithModifiedFieldsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "name", Type: field.TypeString, Size: 10},
		{Name: "with_modified_field_owner", Type: field.TypeInt, Nullable: true},
	}
	// WithModifiedFieldsTable holds the schema information for the "with_modified_fields" table.
	WithModifiedFieldsTable = &schema.Table{
		Name:       "with_modified_fields",
		Columns:    WithModifiedFieldsColumns,
		PrimaryKey: []*schema.Column{WithModifiedFieldsColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "with_modified_fields_users_owner",
				Columns:    []*schema.Column{WithModifiedFieldsColumns[2]},
				RefColumns: []*schema.Column{UsersColumns[0]},
				OnDelete:   schema.SetNull,
			},
		},
	}
	// WithNilFieldsColumns holds the columns for the "with_nil_fields" table.
	WithNilFieldsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
	}
	// WithNilFieldsTable holds the schema information for the "with_nil_fields" table.
	WithNilFieldsTable = &schema.Table{
		Name:       "with_nil_fields",
		Columns:    WithNilFieldsColumns,
		PrimaryKey: []*schema.Column{WithNilFieldsColumns[0]},
	}
	// WithoutFieldsColumns holds the columns for the "without_fields" table.
	WithoutFieldsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
	}
	// WithoutFieldsTable holds the schema information for the "without_fields" table.
	WithoutFieldsTable = &schema.Table{
		Name:       "without_fields",
		Columns:    WithoutFieldsColumns,
		PrimaryKey: []*schema.Column{WithoutFieldsColumns[0]},
	}
	// Tables holds all the tables in the schema.
	Tables = []*schema.Table{
		UsersTable,
		WithFieldsTable,
		WithModifiedFieldsTable,
		WithNilFieldsTable,
		WithoutFieldsTable,
	}
)

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