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 true.
	WithFixture = schema.WithFixture
)

var (
	// AuthorsColumns holds the columns for the "authors" table.
	AuthorsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeUUID},
		{Name: "status", Type: field.TypeInt8, Default: 1},
		{Name: "created_at", Type: field.TypeTime},
		{Name: "updated_at", Type: field.TypeTime},
		{Name: "full_name", Type: field.TypeString},
		{Name: "age", Type: field.TypeInt8},
	}
	// AuthorsTable holds the schema information for the "authors" table.
	AuthorsTable = &schema.Table{
		Name:        "authors",
		Columns:     AuthorsColumns,
		PrimaryKey:  []*schema.Column{AuthorsColumns[0]},
		ForeignKeys: []*schema.ForeignKey{},
	}
	// FilmsColumns holds the columns for the "films" table.
	FilmsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeUUID},
		{Name: "status", Type: field.TypeInt8, Default: 1},
		{Name: "created_at", Type: field.TypeTime},
		{Name: "updated_at", Type: field.TypeTime},
		{Name: "title", Type: field.TypeString},
		{Name: "description", Type: field.TypeString},
	}
	// FilmsTable holds the schema information for the "films" table.
	FilmsTable = &schema.Table{
		Name:        "films",
		Columns:     FilmsColumns,
		PrimaryKey:  []*schema.Column{FilmsColumns[0]},
		ForeignKeys: []*schema.ForeignKey{},
	}
	// FilmAuthorsColumns holds the columns for the "film_authors" table.
	FilmAuthorsColumns = []*schema.Column{
		{Name: "film_id", Type: field.TypeUUID},
		{Name: "author_id", Type: field.TypeUUID},
	}
	// FilmAuthorsTable holds the schema information for the "film_authors" table.
	FilmAuthorsTable = &schema.Table{
		Name:       "film_authors",
		Columns:    FilmAuthorsColumns,
		PrimaryKey: []*schema.Column{FilmAuthorsColumns[0], FilmAuthorsColumns[1]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:  "film_authors_film_id",
				Columns: []*schema.Column{FilmAuthorsColumns[0]},

				RefColumns: []*schema.Column{FilmsColumns[0]},
				OnDelete:   schema.Cascade,
			},
			{
				Symbol:  "film_authors_author_id",
				Columns: []*schema.Column{FilmAuthorsColumns[1]},

				RefColumns: []*schema.Column{AuthorsColumns[0]},
				OnDelete:   schema.Cascade,
			},
		},
	}
	// Tables holds all the tables in the schema.
	Tables = []*schema.Table{
		AuthorsTable,
		FilmsTable,
		FilmAuthorsTable,
	}
)

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