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
)

var (
	// ArgumentsColumns holds the columns for the "arguments" table.
	ArgumentsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "name", Type: field.TypeString},
		{Name: "description", Type: field.TypeString},
		{Name: "type_kind", Type: field.TypeString},
		{Name: "type_name", Type: field.TypeString},
		{Name: "field_type_arguments", Type: field.TypeInt, Nullable: true},
	}
	// ArgumentsTable holds the schema information for the "arguments" table.
	ArgumentsTable = &schema.Table{
		Name:       "arguments",
		Columns:    ArgumentsColumns,
		PrimaryKey: []*schema.Column{ArgumentsColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:  "arguments_field_types_arguments",
				Columns: []*schema.Column{ArgumentsColumns[5]},

				RefColumns: []*schema.Column{FieldTypesColumns[0]},
				OnDelete:   schema.SetNull,
			},
		},
	}
	// FieldTypesColumns holds the columns for the "field_types" table.
	FieldTypesColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "name", Type: field.TypeString},
		{Name: "description", Type: field.TypeString},
		{Name: "deprecated_reason", Type: field.TypeString},
		{Name: "type_kind", Type: field.TypeString},
		{Name: "type_name", Type: field.TypeString},
		{Name: "object_type_fields", Type: field.TypeInt, Nullable: true},
	}
	// FieldTypesTable holds the schema information for the "field_types" table.
	FieldTypesTable = &schema.Table{
		Name:       "field_types",
		Columns:    FieldTypesColumns,
		PrimaryKey: []*schema.Column{FieldTypesColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:  "field_types_object_types_fields",
				Columns: []*schema.Column{FieldTypesColumns[6]},

				RefColumns: []*schema.Column{ObjectTypesColumns[0]},
				OnDelete:   schema.SetNull,
			},
		},
	}
	// ObjectTypesColumns holds the columns for the "object_types" table.
	ObjectTypesColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "name", Type: field.TypeString},
		{Name: "kind", Type: field.TypeString},
		{Name: "description", Type: field.TypeString},
	}
	// ObjectTypesTable holds the schema information for the "object_types" table.
	ObjectTypesTable = &schema.Table{
		Name:        "object_types",
		Columns:     ObjectTypesColumns,
		PrimaryKey:  []*schema.Column{ObjectTypesColumns[0]},
		ForeignKeys: []*schema.ForeignKey{},
	}
	// Tables holds all the tables in the schema.
	Tables = []*schema.Table{
		ArgumentsTable,
		FieldTypesTable,
		ObjectTypesTable,
	}
)

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