introspect

type Catalog struct {
	Tables []entity.Entity
	// Default is where an entity without a schema reads; when unknown, such
	// an entity matches a table name unique in the catalog.
	Default string
	// FoldCase matches schema and table names case-insensitively, as the
	// database compares them (see Physical.FoldCase).
	FoldCase bool
	// contains filtered or unexported fields
}

type Drift struct {
	// Missing lists configured entities/fields absent from the DB
	// (entity name, or "entity.field").
	Missing []string
	// Extra lists DB columns not present in the config.
	Extra []string
	// TypeChanged lists fields whose DB type differs from the config.
	TypeChanged []string
}

type Introspector interface {
	Discover(ctx context.Context, sources []string) ([]entity.Entity, error)
}

type Physical struct {
	// Server identifies the database server; "" when unknown.
	Server string
	// Catalog is the database holding the schemas (PostgreSQL); "" where a
	// schema is a database (MySQL).
	Catalog string
	// FoldCase reports that schema and table names compare
	// case-insensitively (MySQL lower_case_table_names).
	FoldCase bool
}

type PhysicalNamer interface {
	Physical(ctx context.Context) (Physical, error)
}

type Privilege uint8

type PrivilegeInspector interface {
	// ReadOnly reports a server or session that refuses every write (a
	// replica, a hot standby, read_only).
	ReadOnly(ctx context.Context) (bool, error)
	// TablePrivileges reports the privileges on tables of schema ("" for the
	// default one) in one round of queries; a table the connection cannot
	// see is left out.
	TablePrivileges(ctx context.Context, schema string, tables []string) (map[string]TablePrivileges, error)
	// ProcedurePrivilege reports EXECUTE on a procedure; unknown when its
	// name is overloaded.
	ProcedurePrivilege(ctx context.Context, schema, name string) (Privilege, error)
}

type SchemaLister interface {
	Schemas(ctx context.Context) (all []string, current string, err error)
}

type TablePrivileges struct {
	Select, Insert, Update, Delete Privilege
	// Columns lists, per action without a table-level grant, the columns
	// granted at column level ("select", "insert", "update").
	Columns map[string][]string
}