migrate

Documentation

Index

• Variables
• 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
	// WithFixture sets the foreign-key renaming option to the migration when upgrading
	// ent from v0.1.0 (issue-#285). Defaults to false.
	WithFixture = schema.WithFixture
	// WithForeignKeys enables creating foreign-key in schema DDL. This defaults to true.
	WithForeignKeys = schema.WithForeignKeys
)

var (
	// CpusColumns holds the columns for the "cpus" table.
	CpusColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "idx", Type: field.TypeInt},
		{Name: "vendor_id", Type: field.TypeString},
		{Name: "family", Type: field.TypeString},
		{Name: "model", Type: field.TypeString},
		{Name: "model_name", Type: field.TypeString},
		{Name: "created_at", Type: field.TypeTime},
		{Name: "updated_at", Type: field.TypeTime},
		{Name: "host_cpu", Type: field.TypeString, Nullable: true},
	}
	// CpusTable holds the schema information for the "cpus" table.
	CpusTable = &schema.Table{
		Name:       "cpus",
		Columns:    CpusColumns,
		PrimaryKey: []*schema.Column{CpusColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "cpus_hosts_cpu",
				Columns:    []*schema.Column{CpusColumns[8]},
				RefColumns: []*schema.Column{HostsColumns[0]},
				OnDelete:   schema.Cascade,
			},
		},
	}
	// DisksColumns holds the columns for the "disks" table.
	DisksColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "device", Type: field.TypeString},
		{Name: "mount", Type: field.TypeString},
		{Name: "fs_type", Type: field.TypeString},
		{Name: "opts", Type: field.TypeJSON, Nullable: true},
		{Name: "created_at", Type: field.TypeTime},
		{Name: "updated_at", Type: field.TypeTime},
		{Name: "host_disk", Type: field.TypeString},
	}
	// DisksTable holds the schema information for the "disks" table.
	DisksTable = &schema.Table{
		Name:       "disks",
		Columns:    DisksColumns,
		PrimaryKey: []*schema.Column{DisksColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "disks_hosts_disk",
				Columns:    []*schema.Column{DisksColumns[7]},
				RefColumns: []*schema.Column{HostsColumns[0]},
				OnDelete:   schema.Cascade,
			},
		},
	}
	// HostsColumns holds the columns for the "hosts" table.
	HostsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeString, Unique: true},
		{Name: "hostname", Type: field.TypeString},
		{Name: "os", Type: field.TypeString},
		{Name: "platform", Type: field.TypeString},
		{Name: "platform_family", Type: field.TypeString},
		{Name: "platform_version", Type: field.TypeString},
		{Name: "kernel_version", Type: field.TypeString},
		{Name: "kernel_arch", Type: field.TypeString},
		{Name: "virtualization_system", Type: field.TypeString},
		{Name: "virtualization_role", Type: field.TypeString},
		{Name: "created_at", Type: field.TypeTime},
		{Name: "updated_at", Type: field.TypeTime},
	}
	// HostsTable holds the schema information for the "hosts" table.
	HostsTable = &schema.Table{
		Name:       "hosts",
		Columns:    HostsColumns,
		PrimaryKey: []*schema.Column{HostsColumns[0]},
	}
	// NetstatsColumns holds the columns for the "netstats" table.
	NetstatsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "addr", Type: field.TypeString},
		{Name: "port", Type: field.TypeUint64},
		{Name: "proto", Type: field.TypeString},
		{Name: "process", Type: field.TypeString},
		{Name: "created_at", Type: field.TypeTime},
		{Name: "updated_at", Type: field.TypeTime},
		{Name: "host_netstat", Type: field.TypeString},
	}
	// NetstatsTable holds the schema information for the "netstats" table.
	NetstatsTable = &schema.Table{
		Name:       "netstats",
		Columns:    NetstatsColumns,
		PrimaryKey: []*schema.Column{NetstatsColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "netstats_hosts_netstat",
				Columns:    []*schema.Column{NetstatsColumns[7]},
				RefColumns: []*schema.Column{HostsColumns[0]},
				OnDelete:   schema.Cascade,
			},
		},
	}
	// NetworksColumns holds the columns for the "networks" table.
	NetworksColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "idx", Type: field.TypeInt},
		{Name: "mtu", Type: field.TypeInt},
		{Name: "name", Type: field.TypeString},
		{Name: "mac", Type: field.TypeString},
		{Name: "flags", Type: field.TypeJSON, Nullable: true},
		{Name: "addrs", Type: field.TypeJSON, Nullable: true},
		{Name: "created_at", Type: field.TypeTime},
		{Name: "updated_at", Type: field.TypeTime},
		{Name: "host_network", Type: field.TypeString},
	}
	// NetworksTable holds the schema information for the "networks" table.
	NetworksTable = &schema.Table{
		Name:       "networks",
		Columns:    NetworksColumns,
		PrimaryKey: []*schema.Column{NetworksColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "networks_hosts_network",
				Columns:    []*schema.Column{NetworksColumns[9]},
				RefColumns: []*schema.Column{HostsColumns[0]},
				OnDelete:   schema.Cascade,
			},
		},
	}
	// Tables holds all the tables in the schema.
	Tables = []*schema.Table{
		CpusTable,
		DisksTable,
		HostsTable,
		NetstatsTable,
		NetworksTable,
	}
)

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