Interface PublishSqlBuilder

Calls used while publishing and by the deduplication ledger.

interface PublishSqlBuilder {
    AcquirePublishOrderLock(
        topicID: string,
        partitionKey: string,
        timeoutMs: number,
    ): SqlStatement;
    ConfirmDeduplication(
        topicID: string,
        key: string,
        messageID: string,
        ttlSeconds: number,
    ): SqlStatement;
    InsertDeliveries(rows: DeliveryInsertRow[]): SqlStatement;
    InsertMessage(row: MessageInsertRow): SqlStatement;
    PreparePublishOrderLock(timeoutMs: number): SqlStatement;
    PurgeExpiredDeduplications(batchSize: number): SqlStatement;
    ReleaseDeduplication(
        topicID: string,
        key: string,
        messageID: string,
    ): SqlStatement;
    ReserveDeduplication(
        topicID: string,
        key: string,
        messageID: string,
        reserveSeconds: number,
    ): SqlStatement;
    SelectDeduplicationOwner(topicID: string, key: string): SqlStatement;
    SelectMessage(messageID: string): SqlStatement;
}

Implemented by

WorkQueuePublishSql

Index

Methods

AcquirePublishOrderLock ConfirmDeduplication InsertDeliveries InsertMessage PreparePublishOrderLock PurgeExpiredDeduplications ReleaseDeduplication ReserveDeduplication SelectDeduplicationOwner SelectMessage

Methods

AcquirePublishOrderLock

AcquirePublishOrderLock(
    topicID: string,
    partitionKey: string,
    timeoutMs: number,
): SqlStatement
rows LockResultRow (1); a timeout raises an error IsTransientDatabaseError recognises.
Parameters
- topicID: string
- partitionKey: string
- timeoutMs: number
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:17

ConfirmDeduplication

ConfirmDeduplication(
    topicID: string,
    key: string,
    messageID: string,
    ttlSeconds: number,
): SqlStatement
Parameters
- topicID: string
- key: string
- messageID: string
- ttlSeconds: number
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:28

InsertDeliveries

InsertDeliveries(rows: DeliveryInsertRow[]): SqlStatement
One Pending delivery per row, at most DELIVERY_INSERT_CHUNK per call.
Parameters
- rows: DeliveryInsertRow[]
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:23

InsertMessage

InsertMessage(row: MessageInsertRow): SqlStatement
Inserts when no message has this ID; rows MessageInsertedRow (0 = a message with this ID already exists).
Parameters
- row: MessageInsertRow
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:19

PreparePublishOrderLock

PreparePublishOrderLock(timeoutMs: number): SqlStatement
Per-transaction setup the platform needs before taking publish-order locks; null when none.
Parameters
- timeoutMs: number
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:15

PurgeExpiredDeduplications

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

ReleaseDeduplication

ReleaseDeduplication(
    topicID: string,
    key: string,
    messageID: string,
): SqlStatement
Parameters
- topicID: string
- key: string
- messageID: string
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:29

ReserveDeduplication

ReserveDeduplication(
    topicID: string,
    key: string,
    messageID: string,
    reserveSeconds: number,
): SqlStatement
Takes a free or expired key, or re-takes this MessageID's own Reserved row; rows ReservationRow it now owns (0–1).
Parameters
- topicID: string
- key: string
- messageID: string
- reserveSeconds: number
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:25

SelectDeduplicationOwner

SelectDeduplicationOwner(topicID: string, key: string): SqlStatement
rows ReservationRow (0–1).
Parameters
- topicID: string
- key: string
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:27

SelectMessage

SelectMessage(messageID: string): SqlStatement
rows ExistingMessageRow (0–1).
Parameters
- messageID: string
Returns SqlStatement
- Defined in WorkQueue/engine/src/sql/WorkQueueSqlBuilder.ts:21