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 (
	// FnetCategoriesColumns holds the columns for the "fnet_categories" table.
	FnetCategoriesColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "name", Type: field.TypeString, Unique: true},
	}
	// FnetCategoriesTable holds the schema information for the "fnet_categories" table.
	FnetCategoriesTable = &schema.Table{
		Name:       "fnet_categories",
		Columns:    FnetCategoriesColumns,
		PrimaryKey: []*schema.Column{FnetCategoriesColumns[0]},
	}
	// FnetDocumentsColumns holds the columns for the "fnet_documents" table.
	FnetDocumentsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "fnet_id", Type: field.TypeInt, Unique: true},
		{Name: "additional_information", Type: field.TypeString, Nullable: true},
		{Name: "category_str", Type: field.TypeString},
		{Name: "fund_description", Type: field.TypeString},
		{Name: "fund_market_name", Type: field.TypeString, Nullable: true},
		{Name: "high_priority", Type: field.TypeBool},
		{Name: "reference_date", Type: field.TypeTime},
		{Name: "reference_date_format", Type: field.TypeString},
		{Name: "reference_date_str", Type: field.TypeString},
		{Name: "reviewed", Type: field.TypeString},
		{Name: "status", Type: field.TypeString},
		{Name: "sub_category1_str", Type: field.TypeString, Nullable: true},
		{Name: "sub_category2_str", Type: field.TypeString, Nullable: true},
		{Name: "submission_date", Type: field.TypeTime},
		{Name: "submission_date_str", Type: field.TypeString},
		{Name: "submission_method", Type: field.TypeString},
		{Name: "submission_method_description", Type: field.TypeString},
		{Name: "submission_status", Type: field.TypeString},
		{Name: "submission_status_description", Type: field.TypeString},
		{Name: "version", Type: field.TypeInt},
		{Name: "category_id", Type: field.TypeInt},
		{Name: "sub_category1_id", Type: field.TypeInt, Nullable: true},
		{Name: "sub_category2_id", Type: field.TypeInt, Nullable: true},
	}
	// FnetDocumentsTable holds the schema information for the "fnet_documents" table.
	FnetDocumentsTable = &schema.Table{
		Name:       "fnet_documents",
		Columns:    FnetDocumentsColumns,
		PrimaryKey: []*schema.Column{FnetDocumentsColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "fnet_documents_fnet_categories_documents",
				Columns:    []*schema.Column{FnetDocumentsColumns[21]},
				RefColumns: []*schema.Column{FnetCategoriesColumns[0]},
				OnDelete:   schema.NoAction,
			},
			{
				Symbol:     "fnet_documents_fnet_sub_categories1_documents",
				Columns:    []*schema.Column{FnetDocumentsColumns[22]},
				RefColumns: []*schema.Column{FnetSubCategories1Columns[0]},
				OnDelete:   schema.SetNull,
			},
			{
				Symbol:     "fnet_documents_fnet_sub_categories2_documents",
				Columns:    []*schema.Column{FnetDocumentsColumns[23]},
				RefColumns: []*schema.Column{FnetSubCategories2Columns[0]},
				OnDelete:   schema.SetNull,
			},
		},
	}
	// FnetSubCategories1Columns holds the columns for the "fnet_sub_categories1" table.
	FnetSubCategories1Columns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "name", Type: field.TypeString, Unique: true},
	}
	// FnetSubCategories1Table holds the schema information for the "fnet_sub_categories1" table.
	FnetSubCategories1Table = &schema.Table{
		Name:       "fnet_sub_categories1",
		Columns:    FnetSubCategories1Columns,
		PrimaryKey: []*schema.Column{FnetSubCategories1Columns[0]},
	}
	// FnetSubCategories2Columns holds the columns for the "fnet_sub_categories2" table.
	FnetSubCategories2Columns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "name", Type: field.TypeString, Unique: true},
	}
	// FnetSubCategories2Table holds the schema information for the "fnet_sub_categories2" table.
	FnetSubCategories2Table = &schema.Table{
		Name:       "fnet_sub_categories2",
		Columns:    FnetSubCategories2Columns,
		PrimaryKey: []*schema.Column{FnetSubCategories2Columns[0]},
	}
	// Tables holds all the tables in the schema.
	Tables = []*schema.Table{
		FnetCategoriesTable,
		FnetDocumentsTable,
		FnetSubCategories1Table,
		FnetSubCategories2Table,
	}
)

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