migrate

package
v0.1.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 7, 2026 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
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
)
View Source
var (
	// CommentsColumns holds the columns for the "comments" table.
	CommentsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true, SchemaType: map[string]string{"mysql": "int unsigned"}},
	}
	// CommentsTable holds the schema information for the "comments" table.
	CommentsTable = &schema.Table{
		Name:       "comments",
		Columns:    CommentsColumns,
		PrimaryKey: []*schema.Column{CommentsColumns[0]},
	}
	// NodesColumns holds the columns for the "nodes" table.
	NodesColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true, SchemaType: map[string]string{"mysql": "int unsigned"}},
	}
	// NodesTable holds the schema information for the "nodes" table.
	NodesTable = &schema.Table{
		Name:       "nodes",
		Columns:    NodesColumns,
		PrimaryKey: []*schema.Column{NodesColumns[0]},
	}
	// SubscriptionsColumns holds the columns for the "subscriptions" table.
	SubscriptionsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true, SchemaType: map[string]string{"mysql": "int unsigned"}},
		{Name: "muted", Type: field.TypeBool, Default: false},
		{Name: "token", Type: field.TypeString, Size: 32},
		{Name: "created_at", Type: field.TypeTime, SchemaType: map[string]string{"mysql": "datetime"}},
		{Name: "user_id", Type: field.TypeInt, SchemaType: map[string]string{"mysql": "int unsigned"}},
		{Name: "node_id", Type: field.TypeInt, Nullable: true, SchemaType: map[string]string{"mysql": "int unsigned"}},
		{Name: "term_id", Type: field.TypeInt, Nullable: true, SchemaType: map[string]string{"mysql": "int unsigned"}},
	}
	// SubscriptionsTable holds the schema information for the "subscriptions" table.
	SubscriptionsTable = &schema.Table{
		Name:       "subscriptions",
		Columns:    SubscriptionsColumns,
		PrimaryKey: []*schema.Column{SubscriptionsColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "subscriptions_users_user",
				Columns:    []*schema.Column{SubscriptionsColumns[4]},
				RefColumns: []*schema.Column{UsersColumns[0]},
				OnDelete:   schema.Cascade,
			},
			{
				Symbol:     "subscriptions_nodes_node",
				Columns:    []*schema.Column{SubscriptionsColumns[5]},
				RefColumns: []*schema.Column{NodesColumns[0]},
				OnDelete:   schema.Cascade,
			},
			{
				Symbol:     "subscriptions_taxonomy_term_data_term",
				Columns:    []*schema.Column{SubscriptionsColumns[6]},
				RefColumns: []*schema.Column{TaxonomyTermDataColumns[0]},
				OnDelete:   schema.Cascade,
			},
		},
		Indexes: []*schema.Index{
			{
				Name:    "uk_subscriptions_user_node",
				Unique:  true,
				Columns: []*schema.Column{SubscriptionsColumns[4], SubscriptionsColumns[5]},
			},
			{
				Name:    "uk_subscriptions_user_term",
				Unique:  true,
				Columns: []*schema.Column{SubscriptionsColumns[4], SubscriptionsColumns[6]},
			},
			{
				Name:    "idx_subscriptions_node",
				Unique:  false,
				Columns: []*schema.Column{SubscriptionsColumns[5], SubscriptionsColumns[1]},
			},
			{
				Name:    "idx_subscriptions_term",
				Unique:  false,
				Columns: []*schema.Column{SubscriptionsColumns[6], SubscriptionsColumns[1]},
			},
			{
				Name:    "uk_subscriptions_token",
				Unique:  true,
				Columns: []*schema.Column{SubscriptionsColumns[2]},
			},
		},
	}
	// SubscriptionNotificationsColumns holds the columns for the "subscription_notifications" table.
	SubscriptionNotificationsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true, SchemaType: map[string]string{"mysql": "int unsigned"}},
		{Name: "kind", Type: field.TypeString, Size: 16},
		{Name: "created_at", Type: field.TypeTime, SchemaType: map[string]string{"mysql": "datetime"}},
		{Name: "read_at", Type: field.TypeTime, Nullable: true, SchemaType: map[string]string{"mysql": "datetime"}},
		{Name: "mail_state", Type: field.TypeInt8, Default: 0},
		{Name: "user_id", Type: field.TypeInt, SchemaType: map[string]string{"mysql": "int unsigned"}},
		{Name: "node_id", Type: field.TypeInt, SchemaType: map[string]string{"mysql": "int unsigned"}},
		{Name: "comment_id", Type: field.TypeInt, Nullable: true, SchemaType: map[string]string{"mysql": "int unsigned"}},
		{Name: "actor_id", Type: field.TypeInt, Nullable: true, SchemaType: map[string]string{"mysql": "int unsigned"}},
		{Name: "term_id", Type: field.TypeInt, Nullable: true, SchemaType: map[string]string{"mysql": "int unsigned"}},
	}
	// SubscriptionNotificationsTable holds the schema information for the "subscription_notifications" table.
	SubscriptionNotificationsTable = &schema.Table{
		Name:       "subscription_notifications",
		Columns:    SubscriptionNotificationsColumns,
		PrimaryKey: []*schema.Column{SubscriptionNotificationsColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "subscription_notifications_users_user",
				Columns:    []*schema.Column{SubscriptionNotificationsColumns[5]},
				RefColumns: []*schema.Column{UsersColumns[0]},
				OnDelete:   schema.Cascade,
			},
			{
				Symbol:     "subscription_notifications_nodes_node",
				Columns:    []*schema.Column{SubscriptionNotificationsColumns[6]},
				RefColumns: []*schema.Column{NodesColumns[0]},
				OnDelete:   schema.Cascade,
			},
			{
				Symbol:     "subscription_notifications_comments_comment",
				Columns:    []*schema.Column{SubscriptionNotificationsColumns[7]},
				RefColumns: []*schema.Column{CommentsColumns[0]},
				OnDelete:   schema.Cascade,
			},
			{
				Symbol:     "subscription_notifications_users_actor",
				Columns:    []*schema.Column{SubscriptionNotificationsColumns[8]},
				RefColumns: []*schema.Column{UsersColumns[0]},
				OnDelete:   schema.SetNull,
			},
			{
				Symbol:     "subscription_notifications_taxonomy_term_data_term",
				Columns:    []*schema.Column{SubscriptionNotificationsColumns[9]},
				RefColumns: []*schema.Column{TaxonomyTermDataColumns[0]},
				OnDelete:   schema.Cascade,
			},
		},
		Indexes: []*schema.Index{
			{
				Name:    "idx_subscription_notifications_user",
				Unique:  false,
				Columns: []*schema.Column{SubscriptionNotificationsColumns[5], SubscriptionNotificationsColumns[3]},
			},
			{
				Name:    "idx_subscription_notifications_mail",
				Unique:  false,
				Columns: []*schema.Column{SubscriptionNotificationsColumns[4], SubscriptionNotificationsColumns[5]},
			},
			{
				Name:    "idx_subscription_notifications_created",
				Unique:  false,
				Columns: []*schema.Column{SubscriptionNotificationsColumns[2]},
			},
			{
				Name:    "subscriptionnotification_actor_id",
				Unique:  false,
				Columns: []*schema.Column{SubscriptionNotificationsColumns[8]},
			},
			{
				Name:    "subscriptionnotification_comment_id",
				Unique:  false,
				Columns: []*schema.Column{SubscriptionNotificationsColumns[7]},
			},
			{
				Name:    "subscriptionnotification_node_id",
				Unique:  false,
				Columns: []*schema.Column{SubscriptionNotificationsColumns[6]},
			},
			{
				Name:    "subscriptionnotification_term_id",
				Unique:  false,
				Columns: []*schema.Column{SubscriptionNotificationsColumns[9]},
			},
		},
	}
	// SubscriptionSettingsColumns holds the columns for the "subscription_settings" table.
	SubscriptionSettingsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true, SchemaType: map[string]string{"mysql": "int unsigned"}},
		{Name: "mail_subject", Type: field.TypeString, Size: 255, Default: ""},
		{Name: "mail_body", Type: field.TypeString, Nullable: true, Size: 2147483647, SchemaType: map[string]string{"mysql": "text"}},
		{Name: "digest_day", Type: field.TypeString, Size: 10, Default: ""},
	}
	// SubscriptionSettingsTable holds the schema information for the "subscription_settings" table.
	SubscriptionSettingsTable = &schema.Table{
		Name:       "subscription_settings",
		Columns:    SubscriptionSettingsColumns,
		PrimaryKey: []*schema.Column{SubscriptionSettingsColumns[0]},
	}
	// SubscriptionUserSettingsColumns holds the columns for the "subscription_user_settings" table.
	SubscriptionUserSettingsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true, SchemaType: map[string]string{"mysql": "int unsigned"}},
		{Name: "mail", Type: field.TypeString, Size: 8, Default: "now"},
		{Name: "replies", Type: field.TypeBool, Default: true},
		{Name: "auto_own", Type: field.TypeBool, Default: true},
		{Name: "auto_commented", Type: field.TypeBool, Default: true},
		{Name: "user_id", Type: field.TypeInt, SchemaType: map[string]string{"mysql": "int unsigned"}},
	}
	// SubscriptionUserSettingsTable holds the schema information for the "subscription_user_settings" table.
	SubscriptionUserSettingsTable = &schema.Table{
		Name:       "subscription_user_settings",
		Columns:    SubscriptionUserSettingsColumns,
		PrimaryKey: []*schema.Column{SubscriptionUserSettingsColumns[0]},
		ForeignKeys: []*schema.ForeignKey{
			{
				Symbol:     "subscription_user_settings_users_user",
				Columns:    []*schema.Column{SubscriptionUserSettingsColumns[5]},
				RefColumns: []*schema.Column{UsersColumns[0]},
				OnDelete:   schema.Cascade,
			},
		},
		Indexes: []*schema.Index{
			{
				Name:    "uk_subscription_user_settings_user",
				Unique:  true,
				Columns: []*schema.Column{SubscriptionUserSettingsColumns[5]},
			},
		},
	}
	// TaxonomyTermDataColumns holds the columns for the "taxonomy_term_data" table.
	TaxonomyTermDataColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true, SchemaType: map[string]string{"mysql": "int unsigned"}},
	}
	// TaxonomyTermDataTable holds the schema information for the "taxonomy_term_data" table.
	TaxonomyTermDataTable = &schema.Table{
		Name:       "taxonomy_term_data",
		Columns:    TaxonomyTermDataColumns,
		PrimaryKey: []*schema.Column{TaxonomyTermDataColumns[0]},
	}
	// UsersColumns holds the columns for the "users" table.
	UsersColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true, SchemaType: map[string]string{"mysql": "int unsigned"}},
	}
	// 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{
		CommentsTable,
		NodesTable,
		SubscriptionsTable,
		SubscriptionNotificationsTable,
		SubscriptionSettingsTable,
		SubscriptionUserSettingsTable,
		TaxonomyTermDataTable,
		UsersTable,
	}
)

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL