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 (
	// BooksColumns holds the columns for the "books" table.
	BooksColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "title", Type: field.TypeString, Size: 1024},
		{Name: "book_id", Type: field.TypeString, Unique: true},
		{Name: "owner", Type: field.TypeString, Default: "admin"},
		{Name: "file_path", Type: field.TypeString},
		{Name: "book_store_path", Type: field.TypeString},
		{Name: "type", Type: field.TypeString},
		{Name: "child_book_num", Type: field.TypeInt},
		{Name: "depth", Type: field.TypeInt},
		{Name: "parent_folder", Type: field.TypeString},
		{Name: "page_count", Type: field.TypeInt},
		{Name: "file_size", Type: field.TypeInt64},
		{Name: "authors", Type: field.TypeString},
		{Name: "isbn", Type: field.TypeString},
		{Name: "press", Type: field.TypeString},
		{Name: "published_at", Type: field.TypeString},
		{Name: "extract_path", Type: field.TypeString},
		{Name: "modified", Type: field.TypeTime},
		{Name: "extract_num", Type: field.TypeInt},
		{Name: "init_complete", Type: field.TypeBool},
		{Name: "read_percent", Type: field.TypeFloat64},
		{Name: "non_utf8zip", Type: field.TypeBool},
		{Name: "zip_text_encoding", Type: field.TypeString},
	}
	// BooksTable holds the schema information for the "books" table.
	BooksTable = &schema.Table{
		Name:       "books",
		Columns:    BooksColumns,
		PrimaryKey: []*schema.Column{BooksColumns[0]},
	}
	// SinglePageInfosColumns holds the columns for the "single_page_infos" table.
	SinglePageInfosColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "book_id", Type: field.TypeString},
		{Name: "page_num", Type: field.TypeInt},
		{Name: "name_in_archive", Type: field.TypeString},
		{Name: "url", Type: field.TypeString},
		{Name: "blur_hash", Type: field.TypeString},
		{Name: "height", Type: field.TypeInt},
		{Name: "width", Type: field.TypeInt},
		{Name: "mode_time", Type: field.TypeTime},
		{Name: "file_size", Type: field.TypeInt64},
		{Name: "real_image_file_path", Type: field.TypeString},
		{Name: "img_type", Type: field.TypeString},
		{Name: "book_page_infos", Type: field.TypeInt, Nullable: true},
	}
	// SinglePageInfosTable holds the schema information for the "single_page_infos" table.
	SinglePageInfosTable = &schema.Table{
		Name:       "single_page_infos",
		Columns:    SinglePageInfosColumns,
		PrimaryKey: []*schema.Column{SinglePageInfosColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "single_page_infos_books_PageInfos",
				Columns:    []*schema.Column{SinglePageInfosColumns[12]},
				RefColumns: []*schema.Column{BooksColumns[0]},
				OnDelete:   schema.SetNull,
			},
		},
	}
	// UsersColumns holds the columns for the "users" table.
	UsersColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "name", Type: field.TypeString, Unique: true, Size: 50},
		{Name: "created_at", Type: field.TypeTime},
		{Name: "username", Type: field.TypeString, Unique: true, Size: 50},
		{Name: "password", Type: field.TypeString},
		{Name: "last_login", Type: field.TypeTime},
		{Name: "age", Type: field.TypeInt},
	}
	// UsersTable holds the schema information for the "users" table.
	UsersTable = &schema.Table{
		Name:       "users",
		Columns:    UsersColumns,
		PrimaryKey: []*schema.Column{UsersColumns[0]},
	}
	// Tables holds all the tables in the schema.
	Tables = []*schema.Table{
		BooksTable,
		SinglePageInfosTable,
		UsersTable,
	}
)

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