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 (
	// CompatibilityResultsColumns holds the columns for the "compatibility_results" table.
	CompatibilityResultsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "result", Type: field.TypeBool},
		{Name: "mapping", Type: field.TypeJSON, Nullable: true},
		{Name: "created_at", Type: field.TypeTime},
		{Name: "updated_at", Type: field.TypeTime},
		{Name: "requirement_contract_id", Type: field.TypeString, Size: 128},
		{Name: "provider_contract_id", Type: field.TypeString, Size: 128},
	}
	// CompatibilityResultsTable holds the schema information for the "compatibility_results" table.
	CompatibilityResultsTable = &schema.Table{
		Name:       "compatibility_results",
		Columns:    CompatibilityResultsColumns,
		PrimaryKey: []*schema.Column{CompatibilityResultsColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "compatibility_results_registered_contracts_requirement_contract",
				Columns:    []*schema.Column{CompatibilityResultsColumns[5]},
				RefColumns: []*schema.Column{RegisteredContractsColumns[0]},
				OnDelete:   schema.NoAction,
			},
			{
				Symbol:     "compatibility_results_registered_contracts_provider_contract",
				Columns:    []*schema.Column{CompatibilityResultsColumns[6]},
				RefColumns: []*schema.Column{RegisteredContractsColumns[0]},
				OnDelete:   schema.NoAction,
			},
		},
		Indexes: []*schema.Index{
			{
				Name:    "compatibilityresult_requirement_contract_id_provider_contract_id",
				Unique:  true,
				Columns: []*schema.Column{CompatibilityResultsColumns[5], CompatibilityResultsColumns[6]},
			},
		},
	}
	// RegisteredContractsColumns holds the columns for the "registered_contracts" table.
	RegisteredContractsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeString, Unique: true, Size: 128},
		{Name: "format", Type: field.TypeInt},
		{Name: "contract", Type: field.TypeBytes},
		{Name: "created_at", Type: field.TypeTime},
	}
	// RegisteredContractsTable holds the schema information for the "registered_contracts" table.
	RegisteredContractsTable = &schema.Table{
		Name:       "registered_contracts",
		Columns:    RegisteredContractsColumns,
		PrimaryKey: []*schema.Column{RegisteredContractsColumns[0]},
	}
	// RegisteredProvidersColumns holds the columns for the "registered_providers" table.
	RegisteredProvidersColumns = []*schema.Column{
		{Name: "id", Type: field.TypeUUID, Unique: true},
		{Name: "url", Type: field.TypeJSON},
		{Name: "created_at", Type: field.TypeTime},
		{Name: "updated_at", Type: field.TypeTime},
		{Name: "contract_id", Type: field.TypeString, Size: 128},
	}
	// RegisteredProvidersTable holds the schema information for the "registered_providers" table.
	RegisteredProvidersTable = &schema.Table{
		Name:       "registered_providers",
		Columns:    RegisteredProvidersColumns,
		PrimaryKey: []*schema.Column{RegisteredProvidersColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "registered_providers_registered_contracts_contract",
				Columns:    []*schema.Column{RegisteredProvidersColumns[4]},
				RefColumns: []*schema.Column{RegisteredContractsColumns[0]},
				OnDelete:   schema.NoAction,
			},
		},
	}
	// Tables holds all the tables in the schema.
	Tables = []*schema.Table{
		CompatibilityResultsTable,
		RegisteredContractsTable,
		RegisteredProvidersTable,
	}
)

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