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 (
	// EventsColumns holds the columns for the "events" table.
	EventsColumns = []*schema.Column{
		{Name: "oid", Type: field.TypeUUID},
		{Name: "event_time", Type: field.TypeTime},
		{Name: "event_name", Type: field.TypeString},
		{Name: "username", Type: field.TypeString},
		{Name: "resource", Type: field.TypeString, Default: "-"},
		{Name: "source_ip", Type: field.TypeString, Default: "-"},
		{Name: "request_id", Type: field.TypeString, Default: "-"},
		{Name: "read_only", Type: field.TypeBool, Default: false},
		{Name: "event_data", Type: field.TypeJSON},
		{Name: "event_source", Type: field.TypeString, Default: "auditmon_internal"},
	}
	// EventsTable holds the schema information for the "events" table.
	EventsTable = &schema.Table{
		Name:       "events",
		Columns:    EventsColumns,
		PrimaryKey: []*schema.Column{EventsColumns[0]},
		Indexes: []*schema.Index{
			{
				Name:    "event_event_time_event_name_username",
				Unique:  false,
				Columns: []*schema.Column{EventsColumns[1], EventsColumns[2], EventsColumns[3]},
			},
		},
	}
	// EventNameAutofillsColumns holds the columns for the "event_name_autofills" table.
	EventNameAutofillsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "event_name", Type: field.TypeString, Unique: true},
	}
	// EventNameAutofillsTable holds the schema information for the "event_name_autofills" table.
	EventNameAutofillsTable = &schema.Table{
		Name:       "event_name_autofills",
		Columns:    EventNameAutofillsColumns,
		PrimaryKey: []*schema.Column{EventNameAutofillsColumns[0]},
	}
	// UsersColumns holds the columns for the "users" table.
	UsersColumns = []*schema.Column{
		{Name: "oid", Type: field.TypeUUID},
		{Name: "username", Type: field.TypeString, Unique: true},
		{Name: "hashed_password", Type: field.TypeString},
		{Name: "role", Type: field.TypeString},
		{Name: "created_at", Type: field.TypeTime},
		{Name: "password_last_set_at", Type: field.TypeTime},
		{Name: "force_password_change", Type: field.TypeBool, Default: false},
		{Name: "last_login", Type: field.TypeTime},
		{Name: "failed_logins", Type: field.TypeInt, Default: 0},
		{Name: "locked", Type: field.TypeBool, Default: false},
		{Name: "locked_until", Type: field.TypeTime},
		{Name: "mfa_secret", Type: field.TypeString, Nullable: true},
		{Name: "mfa_setup_completed", Type: field.TypeBool, Default: false},
		{Name: "recent_passwords", Type: field.TypeJSON, Nullable: true},
		{Name: "mfa_image", Type: field.TypeBytes, Nullable: true},
		{Name: "timezone", Type: field.TypeString, Nullable: true},
	}
	// UsersTable holds the schema information for the "users" table.
	UsersTable = &schema.Table{
		Name:       "users",
		Columns:    UsersColumns,
		PrimaryKey: []*schema.Column{UsersColumns[0]},
	}
	// UsernameAutofillsColumns holds the columns for the "username_autofills" table.
	UsernameAutofillsColumns = []*schema.Column{
		{Name: "id", Type: field.TypeInt, Increment: true},
		{Name: "username", Type: field.TypeString, Unique: true},
	}
	// UsernameAutofillsTable holds the schema information for the "username_autofills" table.
	UsernameAutofillsTable = &schema.Table{
		Name:       "username_autofills",
		Columns:    UsernameAutofillsColumns,
		PrimaryKey: []*schema.Column{UsernameAutofillsColumns[0]},
	}
	// Tables holds all the tables in the schema.
	Tables = []*schema.Table{
		EventsTable,
		EventNameAutofillsTable,
		UsersTable,
		UsernameAutofillsTable,
	}
)

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