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 (
	// AppsColumns holds the columns for the "apps" table.
	AppsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "uuid", Type: field.TypeUUID, Unique: true},
		{Name: "name", Type: field.TypeString, Unique: true},
		{Name: "secret_key", Type: field.TypeUUID},
		{Name: "user_apps", Type: field.TypeInt, Nullable: true},
	}
	// AppsTable holds the schema information for the "apps" table.
	AppsTable = &schema.Table{
		Name:       "apps",
		Columns:    AppsColumns,
		PrimaryKey: []*schema.Column{AppsColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "apps_users_apps",
				Columns:    []*schema.Column{AppsColumns[4]},
				RefColumns: []*schema.Column{UsersColumns[0]},
				OnDelete:   schema.SetNull,
			},
		},
	}
	// HomesColumns holds the columns for the "homes" table.
	HomesColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "uuid", Type: field.TypeUUID, Unique: true},
		{Name: "name", Type: field.TypeString, Unique: true},
	}
	// HomesTable holds the schema information for the "homes" table.
	HomesTable = &schema.Table{
		Name:       "homes",
		Columns:    HomesColumns,
		PrimaryKey: []*schema.Column{HomesColumns[0]},
	}
	// HomeConnectionsColumns holds the columns for the "home_connections" table.
	HomeConnectionsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "start_time", Type: field.TypeString, Default: "00:00:00"},
		{Name: "end_time", Type: field.TypeString, Default: "00:00:00"},
		{Name: "home_connection_user", Type: field.TypeInt, Nullable: true},
		{Name: "home_connection_home", Type: field.TypeInt, Nullable: true},
	}
	// HomeConnectionsTable holds the schema information for the "home_connections" table.
	HomeConnectionsTable = &schema.Table{
		Name:       "home_connections",
		Columns:    HomeConnectionsColumns,
		PrimaryKey: []*schema.Column{HomeConnectionsColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "home_connections_users_user",
				Columns:    []*schema.Column{HomeConnectionsColumns[3]},
				RefColumns: []*schema.Column{UsersColumns[0]},
				OnDelete:   schema.SetNull,
			},
			{
				Symbol:     "home_connections_homes_home",
				Columns:    []*schema.Column{HomeConnectionsColumns[4]},
				RefColumns: []*schema.Column{HomesColumns[0]},
				OnDelete:   schema.SetNull,
			},
		},
	}
	// RoomsColumns holds the columns for the "rooms" table.
	RoomsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "uuid", Type: field.TypeUUID, Unique: true},
		{Name: "name", Type: field.TypeString, Unique: true},
		{Name: "home_rooms", Type: field.TypeInt, Nullable: true},
	}
	// RoomsTable holds the schema information for the "rooms" table.
	RoomsTable = &schema.Table{
		Name:       "rooms",
		Columns:    RoomsColumns,
		PrimaryKey: []*schema.Column{RoomsColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "rooms_homes_rooms",
				Columns:    []*schema.Column{RoomsColumns[3]},
				RefColumns: []*schema.Column{HomesColumns[0]},
				OnDelete:   schema.SetNull,
			},
		},
	}
	// RoomConnectionsColumns holds the columns for the "room_connections" table.
	RoomConnectionsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "start_time", Type: field.TypeString, Default: "00:00:00"},
		{Name: "end_time", Type: field.TypeString, Default: "00:00:00"},
		{Name: "room_connection_user", Type: field.TypeInt, Nullable: true},
		{Name: "room_connection_room", Type: field.TypeInt, Nullable: true},
	}
	// RoomConnectionsTable holds the schema information for the "room_connections" table.
	RoomConnectionsTable = &schema.Table{
		Name:       "room_connections",
		Columns:    RoomConnectionsColumns,
		PrimaryKey: []*schema.Column{RoomConnectionsColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "room_connections_users_user",
				Columns:    []*schema.Column{RoomConnectionsColumns[3]},
				RefColumns: []*schema.Column{UsersColumns[0]},
				OnDelete:   schema.SetNull,
			},
			{
				Symbol:     "room_connections_rooms_room",
				Columns:    []*schema.Column{RoomConnectionsColumns[4]},
				RefColumns: []*schema.Column{RoomsColumns[0]},
				OnDelete:   schema.SetNull,
			},
		},
	}
	// ThingsColumns holds the columns for the "things" table.
	ThingsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "uuid", Type: field.TypeUUID, Unique: true},
		{Name: "name", Type: field.TypeString, Unique: true},
		{Name: "secret_key", Type: field.TypeUUID},
		{Name: "room_things", Type: field.TypeInt, Nullable: true},
	}
	// ThingsTable holds the schema information for the "things" table.
	ThingsTable = &schema.Table{
		Name:       "things",
		Columns:    ThingsColumns,
		PrimaryKey: []*schema.Column{ThingsColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "things_rooms_things",
				Columns:    []*schema.Column{ThingsColumns[4]},
				RefColumns: []*schema.Column{RoomsColumns[0]},
				OnDelete:   schema.SetNull,
			},
		},
	}
	// ThingConnectionsColumns holds the columns for the "thing_connections" table.
	ThingConnectionsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "start_time", Type: field.TypeString, Default: "00:00:00"},
		{Name: "end_time", Type: field.TypeString, Default: "00:00:00"},
		{Name: "thing_connection_user", Type: field.TypeInt, Nullable: true},
		{Name: "thing_connection_thing", Type: field.TypeInt, Nullable: true},
	}
	// ThingConnectionsTable holds the schema information for the "thing_connections" table.
	ThingConnectionsTable = &schema.Table{
		Name:       "thing_connections",
		Columns:    ThingConnectionsColumns,
		PrimaryKey: []*schema.Column{ThingConnectionsColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "thing_connections_users_user",
				Columns:    []*schema.Column{ThingConnectionsColumns[3]},
				RefColumns: []*schema.Column{UsersColumns[0]},
				OnDelete:   schema.SetNull,
			},
			{
				Symbol:     "thing_connections_things_thing",
				Columns:    []*schema.Column{ThingConnectionsColumns[4]},
				RefColumns: []*schema.Column{ThingsColumns[0]},
				OnDelete:   schema.SetNull,
			},
		},
	}
	// UsersColumns holds the columns for the "users" table.
	UsersColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "uuid", Type: field.TypeUUID, Unique: true},
		{Name: "name", Type: field.TypeString, Unique: true},
		{Name: "password", Type: field.TypeString},
		{Name: "access_key", Type: field.TypeUUID, Unique: true},
		{Name: "secret_key", Type: field.TypeUUID},
		{Name: "super_user", Type: field.TypeBool},
	}
	// UsersTable holds the schema information for the "users" table.
	UsersTable = &schema.Table{
		Name:       "users",
		Columns:    UsersColumns,
		PrimaryKey: []*schema.Column{UsersColumns[0]},
	}
	// Tables holds all the tables in the schema.
	Tables = []*schema.Table{
		AppsTable,
		HomesTable,
		HomeConnectionsTable,
		RoomsTable,
		RoomConnectionsTable,
		ThingsTable,
		ThingConnectionsTable,
		UsersTable,
	}
)

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