executor

package

Go to main page

Versions in this module

v0

v0.3.3

Sep 16, 2026

Changes in this version

+ var ErrCreateOwnerMismatch = errors.New("the CREATE TABLE committed with an unexpected owner")

+ var ErrCreateOwnerUnverified = errors.New("the CREATE TABLE committed but its owner could not be read")

+ var ErrInvalidBlockingBudget = errors.New("invalid accepted-blocking budget")

+ var ErrUnsupportedAcceptedBlocking = errors.New("statement is not an accepted blocking index statement")

+ type BlockingBudget struct

+ LockTimeout time.Duration

+ StatementTimeout time.Duration

+ type BlockingExecutionError struct

+ Err error

+ func (e *BlockingExecutionError) Error() string

+ func (e *BlockingExecutionError) Unwrap() error

+ type BlockingOutcomeUnknownError struct

+ Err error

+ func (e *BlockingOutcomeUnknownError) Error() string

+ func (e *BlockingOutcomeUnknownError) Unwrap() error

+ type BlockingReport struct

+ Duration time.Duration

+ LockTimeout time.Duration

+ SQL string

+ StatementTimeout time.Duration

+ func ExecuteAcceptedBlocking(ctx context.Context, pool *pgxpool.Pool, sql string, b BlockingBudget) (BlockingReport, error)

type Code

+ const CodeBlockingOutcomeUnknown

+ const CodeCreateOwnerMismatch

+ const CodeCreateOwnerUnverified

+ const CodeInvalidBlockingBudget

+ const CodeUnsupportedAcceptedBlocking

+ type CreateOwnerMismatchError struct

+ Actual string

+ Expected string

+ func (e *CreateOwnerMismatchError) Error() string

+ func (e *CreateOwnerMismatchError) Unwrap() error

v0.3.2

Sep 10, 2026

Changes in this version

+ var ErrCreateNameMismatch = errors.New(...)

+ var ErrCreateNamesUnverified = errors.New(...)

type Code

+ const CodeCreateNameMismatch

+ const CodeCreateNamesUnverified

+ type CreateNameMismatchError struct

+ Missing []string

+ Schema string

+ Table string

+ Unclaimed []string

+ func (e *CreateNameMismatchError) Error() string

+ func (e *CreateNameMismatchError) Unwrap() error

type IndexRecoveryReport

+ func DropAbandonedIndex(ctx context.Context, pool *pgxpool.Pool, sql string, b ConcurrentBudget) (IndexRecoveryReport, error)

v0.3.1

Sep 7, 2026

Changes in this version

+ type CreateShapeCause string

+ const CreateShapeConcurrently

+ const CreateShapeDuplicateName

+ const CreateShapeIfNotExists

+ const CreateShapeInherits

+ const CreateShapeLike

+ const CreateShapeMultipleOperations

+ const CreateShapeOfType

+ const CreateShapePartitionOf

+ const CreateShapeUnsupportedKind

+ func CreateShapeCauseOf(err error) CreateShapeCause

+ func CreateShapeCauses() []CreateShapeCause

+ func (c CreateShapeCause) Description() string

+ type CreateShapeError struct

+ Cause CreateShapeCause

+ Name string

+ func (e *CreateShapeError) Error() string

+ func (e *CreateShapeError) Unwrap() error

v0.3.0

Sep 7, 2026

Changes in this version

+ var ErrAbandonedInvalidIndex = errors.New("an abandoned invalid index with this name already exists on the target table")

+ var ErrAbandonmentUnproven = errors.New("the invalid index could not be proven abandoned through to its removal")

+ var ErrCallerOwnedNeedsCancellableContext = errors.New(...)

+ var ErrCallerOwnedOverallBudget = errors.New("a caller-owned build has no server deadline: Overall must be zero")

+ var ErrCancelledByCaller = errors.New("the build was cancelled by its caller's context")

+ var ErrInvalidIndexBuildInFlight = errors.New(...)

+ var ErrInvalidIndexBuilderUnobservable = errors.New(...)

+ var ErrInvalidIndexNotDroppable = errors.New(...)

+ var ErrInvalidIndexOnOtherTable = errors.New(...)

+ var ErrUnboundedBudget = errors.New("the overall budget would leave the statement unbounded")

+ func CreateShapeRefusals(schema string, ds statement.DesiredSchema) ([]error, error)

type BudgetError

+ func (e *BudgetError) Unwrap() error

type Code

+ const CodeCancelledByCaller

+ const CodeInvalidIndexAbandoned

+ const CodeInvalidIndexBuildInFlight

+ const CodeInvalidIndexBuilderUnobservable

+ const CodeInvalidIndexNotDroppable

+ const CodeInvalidIndexOtherTable

+ func (c Code) Permanent() bool

type ConcurrentBudget

+ CallerOwned bool

+ type DroppedIndex struct

+ Duration time.Duration

+ Index string

+ IndexOID uint32

+ Schema string

+ type IndexRecoveryReport struct

+ Build IndexBuildReport

+ Dropped []DroppedIndex

+ Duration time.Duration

+ Skipped []QuarantinedIndex

+ func RebuildAbandonedIndex(ctx context.Context, pool *pgxpool.Pool, sql string, b ConcurrentBudget) (IndexRecoveryReport, error)

type InvalidIndexError

+ BuilderPID uint32

+ Table string

+ func (e *InvalidIndexError) Recoverable() bool

+ type QuarantinedIndex struct

+ Index string

+ IndexOID uint32

+ Schema string

v0.2.0

Aug 30, 2026

Changes in this version

+ var ErrCreateCollision = errors.New("a name the create path needs is already taken")

+ var ErrDuplicateCreateName = errors.New("desired set claims the same relation name twice")

+ var ErrPartitionOfUnsupported = errors.New(...)

+ var ErrUnsupportedCreateStep = errors.New("statement is not a shape the create path can run")

type Code

+ const CodeCreateCollision

+ const CodeDuplicateCreateName

+ const CodePartitionOfUnsupported

+ const CodeUnsupportedCreateStep

+ func Codes() []Code

type SequenceReport

+ func ExecuteCreate(ctx context.Context, pool *pgxpool.Pool, at preflight.AbsentTarget, ...) (SequenceReport, error)

+ func ExecuteCreateWithProgress(ctx context.Context, pool *pgxpool.Pool, at preflight.AbsentTarget, ...) (rep SequenceReport, err error)

type StepKind

+ func StepKinds() []StepKind

v0.1.0

Aug 19, 2026

Changes in this version

+ var ErrBuildLeftInvalidIndex = errors.New("the build left an invalid index behind")

+ var ErrCancelledExternally = errors.New("the build was cancelled from outside the executor before its budget elapsed")

+ var ErrEmptySequence = errors.New("sequence has no steps")

+ var ErrIfNotExistsUnsupported = errors.New(...)

+ var ErrInvariantViolation = errors.New("invariant violation")

+ var ErrNotConcurrentIndexBuild = errors.New("statement is not a CREATE INDEX CONCURRENTLY")

+ var ErrPoolTooSmall = errors.New(...)

+ var ErrPreexistingInvalidIndex = errors.New("an invalid index with this name already exists in the target schema")

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

+ var ErrTargetIdentityChanged = errors.New(...)

+ var ErrUnnamedIndex = errors.New("concurrent index build must name its index")

+ var ErrUnqualifiedTable = errors.New("concurrent index build must schema-qualify its table")

+ var ErrUnsupportedPartitionedParent = errors.New("sequence is not supported on a partitioned parent")

+ var ErrUnsupportedSequenceStep = errors.New("step is not a shape the sequence executor can run safely")

+ func ExecuteNative(ctx context.Context, pool *pgxpool.Pool, pt preflight.PreflightedTable, ...) error

+ func ExecuteNativeWithProgress(ctx context.Context, pool *pgxpool.Pool, pt preflight.PreflightedTable, ...) (err error)

+ type Budget struct

+ LockTimeout time.Duration

+ StatementTimeout time.Duration

+ type BudgetCause int

+ const CauseLock

+ const CauseStatement

+ func (c BudgetCause) String() string

+ type BudgetError struct

+ Attempts int

+ Budget time.Duration

+ Cause BudgetCause

+ func (e *BudgetError) Code() Code

+ func (e *BudgetError) Error() string

+ type Code string

+ const CodeBudgetLockExceeded

+ const CodeBudgetStatementExceeded

+ const CodeCancelledExternally

+ const CodeEmptySequence

+ const CodeExecutionFailed

+ const CodeIfNotExistsUnsupported

+ const CodeInvalidIndexOwnLeftover

+ const CodeInvalidIndexPreexisting

+ const CodeInvalidIndexUnproven

+ const CodeInvariantViolation

+ const CodeNotConcurrentIndexBuild

+ const CodePoolTooSmall

+ const CodeTableNotFound

+ const CodeUnnamedIndex

+ const CodeUnqualifiedTable

+ const CodeUnsupportedPartitionedParent

+ const CodeUnsupportedSequenceStep

+ func OutcomeCode(err error) Code

+ type ConcurrentBudget struct

+ Overall time.Duration

+ type IndexBuildReport struct

+ Duration time.Duration

+ Index string

+ IndexOID uint32

+ Schema string

+ ServerVersion string

+ func BuildIndexConcurrently(ctx context.Context, pool *pgxpool.Pool, sql string, b ConcurrentBudget) (IndexBuildReport, error)

+ func BuildIndexConcurrentlyWithProgress(ctx context.Context, pool *pgxpool.Pool, sql string, b ConcurrentBudget, ...) (rep IndexBuildReport, err error)

+ type InvalidIndexError struct

+ Build error

+ Cleanup error

+ Index string

+ Schema string

+ func (e *InvalidIndexError) Code() Code

+ func (e *InvalidIndexError) Error() string

+ func (e *InvalidIndexError) Unwrap() []error

+ type RetryPolicy struct

+ InitialBackoff time.Duration

+ MaxAttempts int

+ MaxBackoff time.Duration

+ func DefaultRetryPolicy() RetryPolicy

+ type SequenceBudget struct

+ Brief Budget

+ Concurrent ConcurrentBudget

+ Validate ValidateBudget

+ type SequenceReport struct

+ Steps []StepReport

+ func RunSequence(ctx context.Context, pool *pgxpool.Pool, pt preflight.PreflightedTable, ...) (SequenceReport, error)

+ func RunSequenceWithProgress(ctx context.Context, pool *pgxpool.Pool, pt preflight.PreflightedTable, ...) (rep SequenceReport, err error)

+ type SequenceStepError struct

+ Err error

+ Kind StepKind

+ SQL string

+ Step int

+ Total int

+ func (e *SequenceStepError) Code() Code

+ func (e *SequenceStepError) Error() string

+ func (e *SequenceStepError) Unwrap() error

+ type StepKind string

+ const StepBrief

+ const StepConcurrentIndexBuild

+ const StepValidateConstraint

+ type StepReport struct

+ Duration time.Duration

+ Index *IndexBuildReport

+ Kind StepKind

+ SQL string

+ type ValidateBudget struct

+ LockTimeout time.Duration

+ Overall time.Duration

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