Interface ConsumeSqlBuilder

Calls used by a Database consumer: expire, claim, heartbeat, settle, acknowledge a cancel.

interface ConsumeSqlBuilder {
    AcknowledgeCancel(deliveryID: string, leaseToken: string): SqlStatement;
    ClaimPartitionCandidate(
        subscriptionID: string,
        deliveryID: string,
        mode: ClaimPartitionMode,
        leaseOwner: string,
        leaseSeconds: number,
    ): SqlStatement;
    ClaimUnpartitioned(
        subscriptionID: string,
        leaseOwner: string,
        leaseSeconds: number,
        maxRows: number,
    ): SqlStatement;
    CompleteDelivery(deliveryID: string, leaseToken: string): SqlStatement;
    DeadLetterDelivery(
        deliveryID: string,
        leaseToken: string,
        reason: string,
        error: string,
    ): SqlStatement;
    ExpireLeases(subscriptionID: string, maxAttempts: number): SqlStatement;
    ExtendLease(
        deliveryID: string,
        leaseToken: string,
        leaseSeconds: number,
        progressJSON: string,
    ): SqlStatement;
    ReleaseDelivery(deliveryID: string, leaseToken: string): SqlStatement;
    RetryDelivery(
        deliveryID: string,
        leaseToken: string,
        delaySeconds: number,
        error: string,
    ): SqlStatement;
    SelectLeaseState(deliveryID: string, leaseToken: string): SqlStatement;
    SelectPartitionCandidates(
        subscriptionID: string,
        mode: ClaimPartitionMode,
        maxRows: number,
    ): SqlStatement;
    ShiftTimestampsForConformance(
        subscriptionID: string,
        seconds: number,
    ): SqlStatement;
    SubscriptionBacklog(
        subscriptionID: string,
        mode: BacklogPartitionMode,
        cap: number,
    ): SqlStatement;
}

Implemented by

WorkQueueConsumeSql

Index

Methods

AcknowledgeCancel ClaimPartitionCandidate ClaimUnpartitioned CompleteDelivery DeadLetterDelivery ExpireLeases ExtendLease ReleaseDelivery RetryDelivery SelectLeaseState SelectPartitionCandidates ShiftTimestampsForConformance SubscriptionBacklog

Methods

AcknowledgeCancel

AcknowledgeCancel(deliveryID: string, leaseToken: string): SqlStatement
Token-fenced and requires CancelRequestedAt: the cancelled delivery becomes Discarded now (03 §7, F2).
Parameters
- deliveryID: string
- leaseToken: string
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:55

ClaimPartitionCandidate

ClaimPartitionCandidate(
    subscriptionID: string,
    deliveryID: string,
    mode: ClaimPartitionMode,
    leaseOwner: string,
    leaseSeconds: number,
): SqlStatement
rows ClaimedDeliveryRow (0–1).
Parameters
- subscriptionID: string
- deliveryID: string
- mode: ClaimPartitionMode
- leaseOwner: string
- leaseSeconds: number
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:45

ClaimUnpartitioned

ClaimUnpartitioned(
    subscriptionID: string,
    leaseOwner: string,
    leaseSeconds: number,
    maxRows: number,
): SqlStatement
rows ClaimedDeliveryRow.
Parameters
- subscriptionID: string
- leaseOwner: string
- leaseSeconds: number
- maxRows: number
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:38

CompleteDelivery

CompleteDelivery(deliveryID: string, leaseToken: string): SqlStatement
Parameters
- deliveryID: string
- leaseToken: string
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:50

DeadLetterDelivery

DeadLetterDelivery(
    deliveryID: string,
    leaseToken: string,
    reason: string,
    error: string,
): SqlStatement
Parameters
- deliveryID: string
- leaseToken: string
- reason: string
- error: string
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:52

ExpireLeases

ExpireLeases(subscriptionID: string, maxAttempts: number): SqlStatement
rows ExpiredDeadLetterRow: ONLY the deliveries this pass dead-lettered.
Parameters
- subscriptionID: string
- maxAttempts: number
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:36

ExtendLease

ExtendLease(
    deliveryID: string,
    leaseToken: string,
    leaseSeconds: number,
    progressJSON: string,
): SqlStatement
Parameters
- deliveryID: string
- leaseToken: string
- leaseSeconds: number
- progressJSON: string
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:47

ReleaseDelivery

ReleaseDelivery(deliveryID: string, leaseToken: string): SqlStatement
Parameters
- deliveryID: string
- leaseToken: string
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:53

RetryDelivery

RetryDelivery(
    deliveryID: string,
    leaseToken: string,
    delaySeconds: number,
    error: string,
): SqlStatement
Parameters
- deliveryID: string
- leaseToken: string
- delaySeconds: number
- error: string
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:51

SelectLeaseState

SelectLeaseState(deliveryID: string, leaseToken: string): SqlStatement
rows LeaseStateRow (0–1): tells Cancelled from Lost after a zero-row ExtendLease.
Parameters
- deliveryID: string
- leaseToken: string
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:49

SelectPartitionCandidates

SelectPartitionCandidates(
    subscriptionID: string,
    mode: ClaimPartitionMode,
    maxRows: number,
): SqlStatement
rows PartitionCandidateRow: visible Pending rows that satisfy the partition rules, oldest first. May return several rows of one key for Exclusive — the consumer keeps the first per key (03 §7).
Parameters
- subscriptionID: string
- mode: ClaimPartitionMode
- maxRows: number
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:41

ShiftTimestampsForConformance

ShiftTimestampsForConformance(
subscriptionID: string,
seconds: number,
): SqlStatement
Test-only raw UPDATE (not a procedure — never grantable to a runtime role); the conformance harness ages rows.
Parameters
- subscriptionID: string
- seconds: number
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:57

SubscriptionBacklog

SubscriptionBacklog(
    subscriptionID: string,
    mode: BacklogPartitionMode,
    cap: number,
): SqlStatement
rows BacklogRow (exactly 1): the autoscaler metric (03 §11), each count capped.
Parameters
- subscriptionID: string
- mode: BacklogPartitionMode
- cap: number
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:43

Interface ConsumeSqlBuilder

Implemented by

Index

Methods

Methods

AcknowledgeCancel

Parameters

Returns SqlStatement

ClaimPartitionCandidate

Parameters

Returns SqlStatement

ClaimUnpartitioned

Parameters

Returns SqlStatement

CompleteDelivery

Parameters

Returns SqlStatement

DeadLetterDelivery

Parameters

Returns SqlStatement

ExpireLeases

Parameters

Returns SqlStatement

ExtendLease

Parameters

Returns SqlStatement

ReleaseDelivery

Parameters

Returns SqlStatement

RetryDelivery

Parameters

Returns SqlStatement

SelectLeaseState

Parameters

Returns SqlStatement

SelectPartitionCandidates

Parameters

Returns SqlStatement

ShiftTimestampsForConformance

Parameters

Returns SqlStatement

SubscriptionBacklog

Parameters

Returns SqlStatement

Settings

On This Page