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 (
	// AuditEventsColumns holds the columns for the "audit_events" table.
	AuditEventsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "raw", Type: field.TypeString, Size: 2147483647},
		{Name: "level", Type: field.TypeString},
		{Name: "audit_id", Type: field.TypeString},
		{Name: "verb", Type: field.TypeString},
		{Name: "user_agent", Type: field.TypeString},
		{Name: "request_timestamp", Type: field.TypeTime},
		{Name: "stage_timestamp", Type: field.TypeTime},
		{Name: "namespace", Type: field.TypeString, Default: ""},
		{Name: "name", Type: field.TypeString, Default: ""},
		{Name: "api_version", Type: field.TypeString, Default: ""},
		{Name: "api_group", Type: field.TypeString, Default: ""},
		{Name: "resource", Type: field.TypeString, Default: ""},
		{Name: "sub_resource", Type: field.TypeString, Default: ""},
		{Name: "stage", Type: field.TypeString},
	}
	// AuditEventsTable holds the schema information for the "audit_events" table.
	AuditEventsTable = &schema.Table{
		Name:       "audit_events",
		Columns:    AuditEventsColumns,
		PrimaryKey: []*schema.Column{AuditEventsColumns[0]},
		Indexes: []*schema.Index{
			{
				Name:    "auditevent_level_verb",
				Unique:  false,
				Columns: []*schema.Column{AuditEventsColumns[2], AuditEventsColumns[4]},
			},
			{
				Name:    "auditevent_verb",
				Unique:  false,
				Columns: []*schema.Column{AuditEventsColumns[4]},
			},
			{
				Name:    "auditevent_audit_id",
				Unique:  false,
				Columns: []*schema.Column{AuditEventsColumns[3]},
			},
			{
				Name:    "auditevent_user_agent",
				Unique:  false,
				Columns: []*schema.Column{AuditEventsColumns[5]},
			},
			{
				Name:    "auditevent_request_timestamp",
				Unique:  false,
				Columns: []*schema.Column{AuditEventsColumns[6]},
			},
			{
				Name:    "auditevent_stage_timestamp",
				Unique:  false,
				Columns: []*schema.Column{AuditEventsColumns[7]},
			},
		},
	}
	// ResourceKindsColumns holds the columns for the "resource_kinds" table.
	ResourceKindsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "name", Type: field.TypeString, Unique: true},
		{Name: "api_version", Type: field.TypeString, Unique: true},
		{Name: "namespaced", Type: field.TypeBool, Default: true},
		{Name: "kind", Type: field.TypeString, Unique: true},
	}
	// ResourceKindsTable holds the schema information for the "resource_kinds" table.
	ResourceKindsTable = &schema.Table{
		Name:       "resource_kinds",
		Columns:    ResourceKindsColumns,
		PrimaryKey: []*schema.Column{ResourceKindsColumns[0]},
		Indexes: []*schema.Index{
			{
				Name:    "resourcekind_api_version_name",
				Unique:  false,
				Columns: []*schema.Column{ResourceKindsColumns[2], ResourceKindsColumns[1]},
			},
			{
				Name:    "resourcekind_name",
				Unique:  false,
				Columns: []*schema.Column{ResourceKindsColumns[1]},
			},
		},
	}
	// ViewsColumns holds the columns for the "views" table.
	ViewsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
	}
	// ViewsTable holds the schema information for the "views" table.
	ViewsTable = &schema.Table{
		Name:       "views",
		Columns:    ViewsColumns,
		PrimaryKey: []*schema.Column{ViewsColumns[0]},
	}
	// Tables holds all the tables in the schema.
	Tables = []*schema.Table{
		AuditEventsTable,
		ResourceKindsTable,
		ViewsTable,
	}
)

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