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 (
	// DevicesColumns holds the columns for the "devices" table.
	DevicesColumns = []*schema.Column{
		{Name: "id", Type: field.TypeUint64, Increment: true},
		{Name: "create_time", Type: field.TypeTime},
		{Name: "update_time", Type: field.TypeTime},
		{Name: "ip", Type: field.TypeString},
		{Name: "device", Type: field.TypeString},
		{Name: "users_devices", Type: field.TypeUint64, Nullable: true},
	}
	// DevicesTable holds the schema information for the "devices" table.
	DevicesTable = &schema.Table{
		Name:       "devices",
		Columns:    DevicesColumns,
		PrimaryKey: []*schema.Column{DevicesColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "devices_users_devices",
				Columns:    []*schema.Column{DevicesColumns[5]},
				RefColumns: []*schema.Column{UsersColumns[0]},
				OnDelete:   schema.SetNull,
			},
		},
	}
	// DirsColumns holds the columns for the "dirs" table.
	DirsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeUint64, Increment: true},
		{Name: "create_time", Type: field.TypeTime},
		{Name: "update_time", Type: field.TypeTime},
		{Name: "name", Type: field.TypeString},
		{Name: "users_dirs", Type: field.TypeUint64, Nullable: true},
	}
	// DirsTable holds the schema information for the "dirs" table.
	DirsTable = &schema.Table{
		Name:       "dirs",
		Columns:    DirsColumns,
		PrimaryKey: []*schema.Column{DirsColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "dirs_users_dirs",
				Columns:    []*schema.Column{DirsColumns[4]},
				RefColumns: []*schema.Column{UsersColumns[0]},
				OnDelete:   schema.SetNull,
			},
		},
	}
	// FilesColumns holds the columns for the "files" table.
	FilesColumns = []*schema.Column{
		{Name: "id", Type: field.TypeUint64, Increment: true},
		{Name: "hash", Type: field.TypeString, Unique: true},
		{Name: "name", Type: field.TypeString},
		{Name: "size", Type: field.TypeUint64},
	}
	// FilesTable holds the schema information for the "files" table.
	FilesTable = &schema.Table{
		Name:       "files",
		Columns:    FilesColumns,
		PrimaryKey: []*schema.Column{FilesColumns[0]},
		Indexes: []*schema.Index{
			{
				Name:    "files_hash",
				Unique:  true,
				Columns: []*schema.Column{FilesColumns[1]},
			},
		},
	}
	// SavesColumns holds the columns for the "saves" table.
	SavesColumns = []*schema.Column{
		{Name: "id", Type: field.TypeUint64, Increment: true},
		{Name: "create_time", Type: field.TypeTime},
		{Name: "update_time", Type: field.TypeTime},
		{Name: "name", Type: field.TypeString, Size: 255},
		{Name: "caption", Type: field.TypeString, Nullable: true, Size: 255},
		{Name: "files_saves", Type: field.TypeUint64, Nullable: true},
		{Name: "users_saves", Type: field.TypeUint64, Nullable: true},
	}
	// SavesTable holds the schema information for the "saves" table.
	SavesTable = &schema.Table{
		Name:       "saves",
		Columns:    SavesColumns,
		PrimaryKey: []*schema.Column{SavesColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "saves_files_saves",
				Columns:    []*schema.Column{SavesColumns[5]},
				RefColumns: []*schema.Column{FilesColumns[0]},
				OnDelete:   schema.SetNull,
			},
			{
				Symbol:     "saves_users_saves",
				Columns:    []*schema.Column{SavesColumns[6]},
				RefColumns: []*schema.Column{UsersColumns[0]},
				OnDelete:   schema.SetNull,
			},
		},
	}
	// UsersColumns holds the columns for the "users" table.
	UsersColumns = []*schema.Column{
		{Name: "id", Type: field.TypeUint64, Increment: true},
		{Name: "create_time", Type: field.TypeTime},
		{Name: "update_time", Type: field.TypeTime},
		{Name: "username", Type: field.TypeString, Unique: true, Size: 255},
		{Name: "password", Type: field.TypeString, Nullable: true},
		{Name: "email", Type: field.TypeString, Unique: true, Nullable: true},
		{Name: "name", Type: field.TypeString, Nullable: true},
		{Name: "bio", Type: field.TypeString, Nullable: true},
		{Name: "avatar", Type: field.TypeString, Nullable: true},
	}
	// UsersTable holds the schema information for the "users" table.
	UsersTable = &schema.Table{
		Name:       "users",
		Columns:    UsersColumns,
		PrimaryKey: []*schema.Column{UsersColumns[0]},
	}
	// DirsSavesColumns holds the columns for the "dirs_saves" table.
	DirsSavesColumns = []*schema.Column{
		{Name: "dirs_id", Type: field.TypeUint64},
		{Name: "saves_id", Type: field.TypeUint64},
	}
	// DirsSavesTable holds the schema information for the "dirs_saves" table.
	DirsSavesTable = &schema.Table{
		Name:       "dirs_saves",
		Columns:    DirsSavesColumns,
		PrimaryKey: []*schema.Column{DirsSavesColumns[0], DirsSavesColumns[1]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "dirs_saves_dirs_id",
				Columns:    []*schema.Column{DirsSavesColumns[0]},
				RefColumns: []*schema.Column{DirsColumns[0]},
				OnDelete:   schema.Cascade,
			},
			{
				Symbol:     "dirs_saves_saves_id",
				Columns:    []*schema.Column{DirsSavesColumns[1]},
				RefColumns: []*schema.Column{SavesColumns[0]},
				OnDelete:   schema.Cascade,
			},
		},
	}
	// DirsSubdirColumns holds the columns for the "dirs_subdir" table.
	DirsSubdirColumns = []*schema.Column{
		{Name: "dirs_id", Type: field.TypeUint64},
		{Name: "pdir_id", Type: field.TypeUint64},
	}
	// DirsSubdirTable holds the schema information for the "dirs_subdir" table.
	DirsSubdirTable = &schema.Table{
		Name:       "dirs_subdir",
		Columns:    DirsSubdirColumns,
		PrimaryKey: []*schema.Column{DirsSubdirColumns[0], DirsSubdirColumns[1]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "dirs_subdir_dirs_id",
				Columns:    []*schema.Column{DirsSubdirColumns[0]},
				RefColumns: []*schema.Column{DirsColumns[0]},
				OnDelete:   schema.Cascade,
			},
			{
				Symbol:     "dirs_subdir_pdir_id",
				Columns:    []*schema.Column{DirsSubdirColumns[1]},
				RefColumns: []*schema.Column{DirsColumns[0]},
				OnDelete:   schema.Cascade,
			},
		},
	}
	// Tables holds all the tables in the schema.
	Tables = []*schema.Table{
		DevicesTable,
		DirsTable,
		FilesTable,
		SavesTable,
		UsersTable,
		DirsSavesTable,
		DirsSubdirTable,
	}
)

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