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 (
	// LaunchpadsColumns holds the columns for the "launchpads" table.
	LaunchpadsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "is_ready", Type: field.TypeBool, Default: false},
		{Name: "minter_contract", Type: field.TypeJSON},
		{Name: "whitelisted_sale_open", Type: field.TypeBool, Default: false},
		{Name: "public_sale_open", Type: field.TypeBool, Default: false},
		{Name: "is_sold_out", Type: field.TypeBool, Default: false},
		{Name: "is_canceled", Type: field.TypeBool, Default: false},
		{Name: "project_launchpad", Type: field.TypeInt, Unique: true},
	}
	// LaunchpadsTable holds the schema information for the "launchpads" table.
	LaunchpadsTable = &schema.Table{
		Name:       "launchpads",
		Columns:    LaunchpadsColumns,
		PrimaryKey: []*schema.Column{LaunchpadsColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "launchpads_projects_launchpad",
				Columns:    []*schema.Column{LaunchpadsColumns[7]},
				RefColumns: []*schema.Column{ProjectsColumns[0]},
				OnDelete:   schema.NoAction,
			},
		},
	}
	// MintsColumns holds the columns for the "mints" table.
	MintsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "min_value_per_tx", Type: field.TypeString},
		{Name: "max_value_per_tx", Type: field.TypeString},
		{Name: "minter_address", Type: field.TypeString},
		{Name: "project_mint", Type: field.TypeInt, Unique: true},
	}
	// MintsTable holds the schema information for the "mints" table.
	MintsTable = &schema.Table{
		Name:       "mints",
		Columns:    MintsColumns,
		PrimaryKey: []*schema.Column{MintsColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "mints_projects_mint",
				Columns:    []*schema.Column{MintsColumns[4]},
				RefColumns: []*schema.Column{ProjectsColumns[0]},
				OnDelete:   schema.NoAction,
			},
		},
	}
	// ProjectsColumns holds the columns for the "projects" table.
	ProjectsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "address", Type: field.TypeString},
		{Name: "slot", Type: field.TypeInt},
		{Name: "name", Type: field.TypeString},
		{Name: "slug", Type: field.TypeString},
		{Name: "value_decimal", Type: field.TypeInt},
		{Name: "forecasted_apr", Type: field.TypeString, Nullable: true},
		{Name: "total_value", Type: field.TypeString},
		{Name: "payment_token", Type: field.TypeJSON},
		{Name: "metadata", Type: field.TypeJSON},
	}
	// ProjectsTable holds the schema information for the "projects" table.
	ProjectsTable = &schema.Table{
		Name:       "projects",
		Columns:    ProjectsColumns,
		PrimaryKey: []*schema.Column{ProjectsColumns[0]},
		Indexes: []*schema.Index{
			{
				Name:    "project_address_slot",
				Unique:  true,
				Columns: []*schema.Column{ProjectsColumns[1], ProjectsColumns[2]},
			},
		},
	}
	// Tables holds all the tables in the schema.
	Tables = []*schema.Table{
		LaunchpadsTable,
		MintsTable,
		ProjectsTable,
	}
)

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