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 (
	// FmsFilesColumns holds the columns for the "fms_files" table.
	FmsFilesColumns = []*schema.Column{
		{Name: "id", Type: field.TypeUUID},
		{Name: "created_at", Type: field.TypeTime},
		{Name: "updated_at", Type: field.TypeTime},
		{Name: "status", Type: field.TypeUint8, Nullable: true, Default: 1},
		{Name: "name", Type: field.TypeString},
		{Name: "file_type", Type: field.TypeUint8},
		{Name: "size", Type: field.TypeUint64},
		{Name: "path", Type: field.TypeString},
		{Name: "user_uuid", Type: field.TypeString},
		{Name: "md5", Type: field.TypeString},
	}
	// FmsFilesTable holds the schema information for the "fms_files" table.
	FmsFilesTable = &schema.Table{
		Name:       "fms_files",
		Columns:    FmsFilesColumns,
		PrimaryKey: []*schema.Column{FmsFilesColumns[0]},
		Indexes: []*schema.Index{
			{
				Name:    "file_user_uuid",
				Unique:  false,
				Columns: []*schema.Column{FmsFilesColumns[8]},
			},
			{
				Name:    "file_file_type",
				Unique:  false,
				Columns: []*schema.Column{FmsFilesColumns[5]},
			},
		},
	}
	// FmsTagsColumns holds the columns for the "fms_tags" table.
	FmsTagsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeUint64, Increment: true},
		{Name: "created_at", Type: field.TypeTime},
		{Name: "updated_at", Type: field.TypeTime},
		{Name: "status", Type: field.TypeUint8, Nullable: true, Default: 1},
		{Name: "name", Type: field.TypeString, Comment: "Tag's name | 标签名称"},
		{Name: "remark", Type: field.TypeString, Nullable: true, Comment: "The remark of tag | 标签的备注"},
	}
	// FmsTagsTable holds the schema information for the "fms_tags" table.
	FmsTagsTable = &schema.Table{
		Name:       "fms_tags",
		Columns:    FmsTagsColumns,
		PrimaryKey: []*schema.Column{FmsTagsColumns[0]},
		Indexes: []*schema.Index{
			{
				Name:    "tag_name",
				Unique:  false,
				Columns: []*schema.Column{FmsTagsColumns[4]},
			},
		},
	}
	// TagFilesColumns holds the columns for the "tag_files" table.
	TagFilesColumns = []*schema.Column{
		{Name: "tag_id", Type: field.TypeUint64},
		{Name: "file_id", Type: field.TypeUUID},
	}
	// TagFilesTable holds the schema information for the "tag_files" table.
	TagFilesTable = &schema.Table{
		Name:       "tag_files",
		Columns:    TagFilesColumns,
		PrimaryKey: []*schema.Column{TagFilesColumns[0], TagFilesColumns[1]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "tag_files_tag_id",
				Columns:    []*schema.Column{TagFilesColumns[0]},
				RefColumns: []*schema.Column{FmsTagsColumns[0]},
				OnDelete:   schema.Cascade,
			},
			{
				Symbol:     "tag_files_file_id",
				Columns:    []*schema.Column{TagFilesColumns[1]},
				RefColumns: []*schema.Column{FmsFilesColumns[0]},
				OnDelete:   schema.Cascade,
			},
		},
	}
	// Tables holds all the tables in the schema.
	Tables = []*schema.Table{
		FmsFilesTable,
		FmsTagsTable,
		TagFilesTable,
	}
)

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