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 (
	// McmsEmailLogsColumns holds the columns for the "mcms_email_logs" table.
	McmsEmailLogsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeUUID},
		{Name: "created_at", Type: field.TypeTime, Comment: "Create Time | 创建日期"},
		{Name: "updated_at", Type: field.TypeTime, Comment: "Update Time | 修改日期"},
		{Name: "target", Type: field.TypeString, Comment: "The target email address | 目标邮箱地址"},
		{Name: "subject", Type: field.TypeString, Comment: "The subject | 发送的标题"},
		{Name: "content", Type: field.TypeString, Comment: "The content | 发送的内容"},
		{Name: "send_status", Type: field.TypeUint8, Comment: "The send status, 0 unknown 1 success 2 failed | 发送的状态, 0 未知， 1 成功， 2 失败"},
		{Name: "provider", Type: field.TypeString, Comment: "The sms service provider | 短信服务提供商"},
	}
	// McmsEmailLogsTable holds the schema information for the "mcms_email_logs" table.
	McmsEmailLogsTable = &schema.Table{
		Name:       "mcms_email_logs",
		Columns:    McmsEmailLogsColumns,
		PrimaryKey: []*schema.Column{McmsEmailLogsColumns[0]},
	}
	// McmsEmailProvidersColumns holds the columns for the "mcms_email_providers" table.
	McmsEmailProvidersColumns = []*schema.Column{
		{Name: "id", Type: field.TypeUint64, Increment: true},
		{Name: "created_at", Type: field.TypeTime, Comment: "Create Time | 创建日期"},
		{Name: "updated_at", Type: field.TypeTime, Comment: "Update Time | 修改日期"},
		{Name: "name", Type: field.TypeString, Unique: true, Comment: "The email provider name | 电子邮件服务的提供商"},
		{Name: "auth_type", Type: field.TypeUint8, Comment: "The auth type, supported plain, CRAMMD5 | 鉴权类型, 支持 plain, CRAMMD5"},
		{Name: "email_addr", Type: field.TypeString, Comment: "The email address | 邮箱地址"},
		{Name: "password", Type: field.TypeString, Nullable: true, Comment: "The email's password | 电子邮件的密码"},
		{Name: "host_name", Type: field.TypeString, Comment: "The host name is the email service's host address | 电子邮箱服务的服务器地址"},
		{Name: "identify", Type: field.TypeString, Nullable: true, Comment: "The identify info, for CRAMMD5 | 身份信息, 支持 CRAMMD5"},
		{Name: "secret", Type: field.TypeString, Nullable: true, Comment: "The secret, for CRAMMD5 | 邮箱密钥, 用于 CRAMMD5"},
		{Name: "port", Type: field.TypeUint32, Nullable: true, Comment: "The port of the host | 服务器端口"},
		{Name: "tls", Type: field.TypeBool, Comment: "Whether to use TLS | 是否采用 tls 加密", Default: false},
		{Name: "is_default", Type: field.TypeBool, Comment: "Is it the default provider | 是否为默认提供商", Default: false},
	}
	// McmsEmailProvidersTable holds the schema information for the "mcms_email_providers" table.
	McmsEmailProvidersTable = &schema.Table{
		Name:       "mcms_email_providers",
		Columns:    McmsEmailProvidersColumns,
		PrimaryKey: []*schema.Column{McmsEmailProvidersColumns[0]},
	}
	// McmsSmsLogsColumns holds the columns for the "mcms_sms_logs" table.
	McmsSmsLogsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeUUID},
		{Name: "created_at", Type: field.TypeTime, Comment: "Create Time | 创建日期"},
		{Name: "updated_at", Type: field.TypeTime, Comment: "Update Time | 修改日期"},
		{Name: "phone_number", Type: field.TypeString, Comment: "The target phone number | 目标电话"},
		{Name: "content", Type: field.TypeString, Comment: "The content | 发送的内容"},
		{Name: "send_status", Type: field.TypeUint8, Comment: "The send status, 0 unknown 1 success 2 failed | 发送的状态, 0 未知， 1 成功， 2 失败"},
		{Name: "provider", Type: field.TypeString, Comment: "The sms service provider | 短信服务提供商"},
	}
	// McmsSmsLogsTable holds the schema information for the "mcms_sms_logs" table.
	McmsSmsLogsTable = &schema.Table{
		Name:       "mcms_sms_logs",
		Columns:    McmsSmsLogsColumns,
		PrimaryKey: []*schema.Column{McmsSmsLogsColumns[0]},
	}
	// McmsSmsProvidersColumns holds the columns for the "mcms_sms_providers" table.
	McmsSmsProvidersColumns = []*schema.Column{
		{Name: "id", Type: field.TypeUint64, Increment: true},
		{Name: "created_at", Type: field.TypeTime, Comment: "Create Time | 创建日期"},
		{Name: "updated_at", Type: field.TypeTime, Comment: "Update Time | 修改日期"},
		{Name: "name", Type: field.TypeString, Unique: true, Comment: "The SMS provider name | 短信服务的提供商"},
		{Name: "secret_id", Type: field.TypeString, Comment: "The secret ID | 密钥 ID"},
		{Name: "secret_key", Type: field.TypeString, Comment: "The secret key | 密钥 Key"},
		{Name: "region", Type: field.TypeString, Comment: "The service region | 服务器所在地区"},
		{Name: "is_default", Type: field.TypeBool, Comment: "Is it the default provider | 是否为默认提供商", Default: false},
	}
	// McmsSmsProvidersTable holds the schema information for the "mcms_sms_providers" table.
	McmsSmsProvidersTable = &schema.Table{
		Name:       "mcms_sms_providers",
		Columns:    McmsSmsProvidersColumns,
		PrimaryKey: []*schema.Column{McmsSmsProvidersColumns[0]},
	}
	// Tables holds all the tables in the schema.
	Tables = []*schema.Table{
		McmsEmailLogsTable,
		McmsEmailProvidersTable,
		McmsSmsLogsTable,
		McmsSmsProvidersTable,
	}
)

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