preflight

package

Go to main page

Versions in this module

v0

v0.3.3

Sep 16, 2026

Changes in this version

+ var ErrCreateOwnerNotFound = errors.New("create owner role not found")

type CreationRole

+ func CheckCreatePrivilegesAs(ctx context.Context, pool *pgxpool.Pool, schema, owner string) (CreationRole, error)

+ func (c CreationRole) Owner() string

+ func (c CreationRole) SetsRole() bool

v0.3.2

Sep 10, 2026

Changes in this version

+ type CopySwapTarget struct

+ func (t CopySwapTarget) OwnerRole() string

+ func (t CopySwapTarget) PKColumn() string

+ func (t CopySwapTarget) PKType() PKType

+ func (t CopySwapTarget) Schema() string

+ func (t CopySwapTarget) Table() string

+ type PKType string

+ const PKBigint

+ const PKInteger

+ const PKSmallint

type PartitionRefusalCause

+ func PartitionRefusalCauses() []PartitionRefusalCause

v0.3.1

Sep 7, 2026

Changes in this version

+ type OwnedRelationNames struct

+ ConstraintIndexes []string

+ Sequences []string

+ func LookupOwnedRelationNames(ctx context.Context, pool *pgxpool.Pool, schema, table string) (OwnedRelationNames, error)

v0.3.0

Sep 7, 2026

Changes in this version

+ func CheckNamesAbsent(ctx context.Context, pool *pgxpool.Pool, at AbsentTarget, names []string) error

v0.2.0

Aug 30, 2026

Changes in this version

+ var ErrNoCreationSchema = errors.New("the session's search_path names no creation schema")

+ var ErrRelationExists = errors.New("a relation already exists at the target name")

+ var ErrSchemaNotFound = errors.New("schema not found")

+ var ErrTypeExists = errors.New("a type already exists at the target name")

+ func IsNameOccupied(err error) bool

+ type AbsentTarget struct

+ func CheckTableAbsent(ctx context.Context, pool *pgxpool.Pool, schema, table string) (AbsentTarget, error)

+ func (a AbsentTarget) Schema() string

+ func (a AbsentTarget) Table() string

+ type CreationRole struct

+ func CheckCreatePrivileges(ctx context.Context, pool *pgxpool.Pool, schema string) (CreationRole, error)

+ func (c CreationRole) Role() string

+ func (c CreationRole) Schema() string

type Tier

+ const TierCreateTable

v0.1.0

Aug 19, 2026

Changes in this version

+ const NoSizeLimit

+ var ErrNotTable = errors.New("not an ordinary or partitioned table")

+ var ErrTableNotFound = errors.New("table not found")

+ func CheckPartitionSupport(table PreflightedTable, serverMajor int, execSQL []string) error

+ type PartitionRefusalCause string

+ const PartitionCauseBlockingIndexBuild

+ const PartitionCauseConcurrentIndexBuild

+ const PartitionCauseIndexAdoption

+ const PartitionCauseNotValidForeignKey

+ func RefusesPartitionedParent(serverMajor int, execSQL []string) (PartitionRefusalCause, error)

+ type PreflightedTable struct

+ func CheckTable(ctx context.Context, pool *pgxpool.Pool, schema, table string, ...) (PreflightedTable, error)

+ func (t PreflightedTable) Partitioned() bool

+ func (t PreflightedTable) RelTuples() float64

+ func (t PreflightedTable) Schema() string

+ func (t PreflightedTable) Table() string

+ func (t PreflightedTable) TotalBytes() int64

+ type PrivilegeError struct

+ Check string

+ Grant string

+ Hint string

+ Tier Tier

+ func (e *PrivilegeError) Error() string

+ type PrivilegedRole struct

+ func CheckPrivileges(ctx context.Context, pool *pgxpool.Pool, schema, table string, req Requirement) (PrivilegedRole, error)

+ func (p PrivilegedRole) Owner() string

+ func (p PrivilegedRole) Role() string

+ func (p PrivilegedRole) Tier() Tier

+ type Requirement struct

+ LogicalDecoding bool

+ Tier Tier

+ type SizeError struct

+ LimitBytes int64

+ TotalBytes int64

+ func (e *SizeError) Error() string

+ type TargetFacts struct

+ func LookupTargetFacts(ctx context.Context, pool *pgxpool.Pool, schema, table string) (TargetFacts, error)

+ func (f TargetFacts) Partitioned() bool

+ func (f TargetFacts) ServerMajor() int

+ type Tier int

+ const TierAlterInPlace

+ const TierConnect

+ const TierCopyAndSwap

+ const TierIndexBuild

+ func RequiredTier(execSQL []string) (Tier, error)

+ func (t Tier) String() string

+ type UnsupportedPartitionedParentError struct

+ Cause PartitionRefusalCause

+ func (e *UnsupportedPartitionedParentError) Error() string

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