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 (
	// ModulesColumns holds the columns for the "modules" table.
	ModulesColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "owner", Type: field.TypeString},
		{Name: "namespace", Type: field.TypeString},
		{Name: "name", Type: field.TypeString},
		{Name: "provider", Type: field.TypeString},
		{Name: "description", Type: field.TypeString},
		{Name: "source", Type: field.TypeString},
		{Name: "downloads", Type: field.TypeInt64, Default: module.DefaultDownloads},
		{Name: "published_at", Type: field.TypeTime},
		{Name: "installation_id", Type: field.TypeInt64},
		{Name: "app_id", Type: field.TypeInt64},
		{Name: "repo_name", Type: field.TypeString},
	}
	// ModulesTable holds the schema information for the "modules" table.
	ModulesTable = &schema.Table{
		Name:        "modules",
		Columns:     ModulesColumns,
		PrimaryKey:  []*schema.Column{ModulesColumns[0]},
		ForeignKeys: []*schema.ForeignKey{},
	}
	// ModuleVersionsColumns holds the columns for the "module_versions" table.
	ModuleVersionsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "major", Type: field.TypeInt},
		{Name: "minor", Type: field.TypeInt},
		{Name: "patch", Type: field.TypeInt},
		{Name: "tag", Type: field.TypeString},
		{Name: "module_id", Type: field.TypeInt, Nullable: true},
	}
	// ModuleVersionsTable holds the schema information for the "module_versions" table.
	ModuleVersionsTable = &schema.Table{
		Name:       "module_versions",
		Columns:    ModuleVersionsColumns,
		PrimaryKey: []*schema.Column{ModuleVersionsColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:  "module_versions_modules_version",
				Columns: []*schema.Column{ModuleVersionsColumns[5]},

				RefColumns: []*schema.Column{ModulesColumns[0]},
				OnDelete:   schema.SetNull,
			},
		},
	}
	// Tables holds all the tables in the schema.
	Tables = []*schema.Table{
		ModulesTable,
		ModuleVersionsTable,
	}
)

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