Interface OperatorSqlBuilder

Calls used by the operator, the sweeper and topology validation.

interface OperatorSqlBuilder {
    AcquireSweepLock(resource: string): SqlStatement;
    CancelInFlightDelivery(
        subscriptionID: string,
        deliveryID: string,
        actorUserID: string,
        reason: string,
    ): SqlStatement;
    DiscardDelivery(
        subscriptionID: string,
        deliveryID: string,
        allowPending: boolean,
        actorUserID: string,
        reason: string,
    ): SqlStatement;
    ExpireLeasesAll(batchSize?: number): SqlStatement;
    ListDeadLetters(
        subscriptionID: string,
        ordered: boolean,
        after: DeadLetterCursor,
        pageSize: number,
    ): SqlStatement;
    ListPartitions(
        subscriptionID: string,
        ordered: boolean,
        condition: PartitionCondition,
        afterPartitionKey: string,
        pageSize: number,
    ): SqlStatement;
    PurgeOrphanMessages(batchSize: number): SqlStatement;
    PurgeTerminalDeliveries(batchSize: number): SqlStatement;
    ReadCommittedSnapshotState(): SqlStatement;
    ReplayDelivery(
        subscriptionID: string,
        deliveryID: string,
        actorUserID: string,
        note: string,
    ): SqlStatement;
    SubscriptionStats(subscriptionID: string, ordered: boolean): SqlStatement;
}

Implemented by

WorkQueueOperatorSql

Index

Methods

AcquireSweepLock CancelInFlightDelivery DiscardDelivery ExpireLeasesAll ListDeadLetters ListPartitions PurgeOrphanMessages PurgeTerminalDeliveries ReadCommittedSnapshotState ReplayDelivery SubscriptionStats

Methods

AcquireSweepLock

AcquireSweepLock(resource: string): SqlStatement
Transaction-owned, non-blocking application lock (03 §7 "one sweeper at a time"). rows SweepLockRow (1).
Parameters
- resource: string
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:77

CancelInFlightDelivery

CancelInFlightDelivery(
    subscriptionID: string,
    deliveryID: string,
    actorUserID: string,
    reason: string,
): SqlStatement
Cancels an in-flight delivery (03 §7, F2): stamps CancelRequestedAt. The lease token is left unchanged.
Parameters
- subscriptionID: string
- deliveryID: string
- actorUserID: string
- reason: string
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:72

DiscardDelivery

DiscardDelivery(
    subscriptionID: string,
    deliveryID: string,
    allowPending: boolean,
    actorUserID: string,
    reason: string,
): SqlStatement
Parameters
- subscriptionID: string
- deliveryID: string
- allowPending: boolean
- actorUserID: string
- reason: string
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:70

ExpireLeasesAll

ExpireLeasesAll(batchSize?: number): SqlStatement
Sweeper-wide expiry in bounded batches; rows ExpiredDeadLetterRow as ConsumeSqlBuilder.ExpireLeases. batchSize defaults to EXPIRE_LEASES_BATCH: plan 06's sweeper calls it with no argument.
Parameters
- OptionalbatchSize: number
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:75

ListDeadLetters

ListDeadLetters(
    subscriptionID: string,
    ordered: boolean,
    after: DeadLetterCursor,
    pageSize: number,
): SqlStatement
rows DeadLetterRow, keyset-paged by delivery ID.
Parameters
- subscriptionID: string
- ordered: boolean
- after: DeadLetterCursor
- pageSize: number
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:65

ListPartitions

ListPartitions(
    subscriptionID: string,
    ordered: boolean,
    condition: PartitionCondition,
    afterPartitionKey: string,
    pageSize: number,
): SqlStatement
rows PartitionRow, keyset-paged by partition key; condition null = every non-Idle key.
Parameters
- subscriptionID: string
- ordered: boolean
- condition: PartitionCondition
- afterPartitionKey: string
- pageSize: number
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:67

PurgeOrphanMessages

PurgeOrphanMessages(batchSize: number): SqlStatement
Parameters
- batchSize: number
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:81

PurgeTerminalDeliveries

PurgeTerminalDeliveries(batchSize: number): SqlStatement
Parameters
- batchSize: number
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:80

ReadCommittedSnapshotState

ReadCommittedSnapshotState(): SqlStatement
Database prerequisite check (03 §6): READ_COMMITTED_SNAPSHOT on SQL Server. rows IsolationRow (1).

Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:79

ReplayDelivery

ReplayDelivery(
    subscriptionID: string,
    deliveryID: string,
    actorUserID: string,
    note: string,
): SqlStatement
Parameters
- subscriptionID: string
- deliveryID: string
- actorUserID: string
- note: string
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:69

SubscriptionStats

SubscriptionStats(subscriptionID: string, ordered: boolean): SqlStatement
rows StatsRow (1).
Parameters
- subscriptionID: string
- ordered: boolean
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:63

Interface OperatorSqlBuilder

Implemented by

Index

Methods

Methods

AcquireSweepLock

Parameters

Returns SqlStatement

CancelInFlightDelivery

Parameters

Returns SqlStatement

DiscardDelivery

Parameters

Returns SqlStatement

ExpireLeasesAll

Parameters

Returns SqlStatement

ListDeadLetters

Parameters

Returns SqlStatement

ListPartitions

Parameters

Returns SqlStatement

PurgeOrphanMessages

Parameters

Returns SqlStatement

PurgeTerminalDeliveries

Parameters

Returns SqlStatement

ReadCommittedSnapshotState

Returns SqlStatement

ReplayDelivery

Parameters

Returns SqlStatement

SubscriptionStats

Parameters

Returns SqlStatement

Settings

On This Page