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 (
	// CollaborationsColumns holds the columns for the "collaborations" table.
	CollaborationsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "approved", Type: field.TypeBool, Default: false},
		{Name: "create_time", Type: field.TypeTime},
		{Name: "update_time", Type: field.TypeTime},
		{Name: "user_id", Type: field.TypeUUID},
		{Name: "memo_id", Type: field.TypeUUID},
	}
	// CollaborationsTable holds the schema information for the "collaborations" table.
	CollaborationsTable = &schema.Table{
		Name:       "collaborations",
		Columns:    CollaborationsColumns,
		PrimaryKey: []*schema.Column{CollaborationsColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "collaborations_users_collaborator",
				Columns:    []*schema.Column{CollaborationsColumns[4]},
				RefColumns: []*schema.Column{UsersColumns[0]},
				OnDelete:   schema.Cascade,
			},
			{
				Symbol:     "collaborations_memos_memo",
				Columns:    []*schema.Column{CollaborationsColumns[5]},
				RefColumns: []*schema.Column{MemosColumns[0]},
				OnDelete:   schema.Cascade,
			},
		},
		Indexes: []*schema.Index{
			{
				Name:    "collaboration_memo_id_user_id",
				Unique:  true,
				Columns: []*schema.Column{CollaborationsColumns[5], CollaborationsColumns[4]},
			},
			{
				Name:    "collaboration_user_id",
				Unique:  false,
				Columns: []*schema.Column{CollaborationsColumns[4]},
			},
		},
	}
	// MemosColumns holds the columns for the "memos" table.
	MemosColumns = []*schema.Column{
		{Name: "id", Type: field.TypeUUID},
		{Name: "title", Type: field.TypeString, Size: 512},
		{Name: "content", Type: field.TypeString, Size: 20000},
		{Name: "is_published", Type: field.TypeBool, Default: false},
		{Name: "version", Type: field.TypeInt, Default: 0},
		{Name: "create_time", Type: field.TypeTime},
		{Name: "update_time", Type: field.TypeTime},
		{Name: "owner_id", Type: field.TypeUUID},
	}
	// MemosTable holds the schema information for the "memos" table.
	MemosTable = &schema.Table{
		Name:       "memos",
		Columns:    MemosColumns,
		PrimaryKey: []*schema.Column{MemosColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "memos_users_memos",
				Columns:    []*schema.Column{MemosColumns[7]},
				RefColumns: []*schema.Column{UsersColumns[0]},
				OnDelete:   schema.Cascade,
			},
		},
		Indexes: []*schema.Index{
			{
				Name:    "memo_owner_id",
				Unique:  false,
				Columns: []*schema.Column{MemosColumns[7]},
			},
		},
	}
	// SubscriptionsColumns holds the columns for the "subscriptions" table.
	SubscriptionsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "create_time", Type: field.TypeTime},
		{Name: "user_id", Type: field.TypeUUID},
		{Name: "memo_id", Type: field.TypeUUID},
	}
	// SubscriptionsTable holds the schema information for the "subscriptions" table.
	SubscriptionsTable = &schema.Table{
		Name:       "subscriptions",
		Columns:    SubscriptionsColumns,
		PrimaryKey: []*schema.Column{SubscriptionsColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "subscriptions_users_subscriber",
				Columns:    []*schema.Column{SubscriptionsColumns[2]},
				RefColumns: []*schema.Column{UsersColumns[0]},
				OnDelete:   schema.Cascade,
			},
			{
				Symbol:     "subscriptions_memos_memo",
				Columns:    []*schema.Column{SubscriptionsColumns[3]},
				RefColumns: []*schema.Column{MemosColumns[0]},
				OnDelete:   schema.Cascade,
			},
		},
		Indexes: []*schema.Index{
			{
				Name:    "subscription_memo_id_user_id",
				Unique:  true,
				Columns: []*schema.Column{SubscriptionsColumns[3], SubscriptionsColumns[2]},
			},
			{
				Name:    "subscription_user_id",
				Unique:  false,
				Columns: []*schema.Column{SubscriptionsColumns[2]},
			},
		},
	}
	// TagsColumns holds the columns for the "tags" table.
	TagsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "create_time", Type: field.TypeTime},
		{Name: "update_time", Type: field.TypeTime},
		{Name: "name", Type: field.TypeString, Unique: true, Size: 80},
	}
	// TagsTable holds the schema information for the "tags" table.
	TagsTable = &schema.Table{
		Name:       "tags",
		Columns:    TagsColumns,
		PrimaryKey: []*schema.Column{TagsColumns[0]},
	}
	// UsersColumns holds the columns for the "users" table.
	UsersColumns = []*schema.Column{
		{Name: "id", Type: field.TypeUUID},
		{Name: "create_time", Type: field.TypeTime},
		{Name: "update_time", Type: field.TypeTime},
		{Name: "email", Type: field.TypeString, Unique: true, Size: 256},
		{Name: "user_name", Type: field.TypeString, Size: 800},
		{Name: "given_name", Type: field.TypeString, Nullable: true, Size: 800},
		{Name: "family_name", Type: field.TypeString, Nullable: true, Size: 800},
		{Name: "photo_url", Type: field.TypeString, Nullable: true},
		{Name: "type", Type: field.TypeEnum, Enums: []string{"client", "operator"}, Default: "client"},
	}
	// UsersTable holds the schema information for the "users" table.
	UsersTable = &schema.Table{
		Name:       "users",
		Columns:    UsersColumns,
		PrimaryKey: []*schema.Column{UsersColumns[0]},
	}
	// MemoTagsColumns holds the columns for the "memo_tags" table.
	MemoTagsColumns = []*schema.Column{
		{Name: "memo_id", Type: field.TypeUUID},
		{Name: "tag_id", Type: field.TypeInt},
	}
	// MemoTagsTable holds the schema information for the "memo_tags" table.
	MemoTagsTable = &schema.Table{
		Name:       "memo_tags",
		Columns:    MemoTagsColumns,
		PrimaryKey: []*schema.Column{MemoTagsColumns[0], MemoTagsColumns[1]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "memo_tags_memo_id",
				Columns:    []*schema.Column{MemoTagsColumns[0]},
				RefColumns: []*schema.Column{MemosColumns[0]},
				OnDelete:   schema.Cascade,
			},
			{
				Symbol:     "memo_tags_tag_id",
				Columns:    []*schema.Column{MemoTagsColumns[1]},
				RefColumns: []*schema.Column{TagsColumns[0]},
				OnDelete:   schema.Cascade,
			},
		},
	}
	// Tables holds all the tables in the schema.
	Tables = []*schema.Table{
		CollaborationsTable,
		MemosTable,
		SubscriptionsTable,
		TagsTable,
		UsersTable,
		MemoTagsTable,
	}
)

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