Class DatabaseTransportDriver

constructor

• new DatabaseTransportDriver(
      source: WorkQueueExecutorSource,
      deps: TransportDriverDeps,
  ): DatabaseTransportDriver

  Parameters

  • source: WorkQueueExecutorSource
  • deps: TransportDriverDeps

  Returns DatabaseTransportDriver

ReadonlyCapabilities

ReadonlyName

InstanceID

• get InstanceID(): string

  Returns string

AcquirePublishOrderLocks

• AcquirePublishOrderLocks(
      topic: TopicBinding,
      messages: WorkMessage<WorkJson>[],
      subscriptions: SubscriptionBinding[],
      executor: WorkQueueTransactionalExecutor,
  ): Promise<void>

  Takes the publish-order locks a batch needs, in sorted key order, inside the caller's transaction. Two callers publishing the same keys in opposite orders therefore wait for each other instead of deadlocking. Re-acquiring a lock the transaction already holds is a no-op on both platforms, so writeMessage may ask again.

  Parameters

  • topic: TopicBinding
  • messages: WorkMessage<WorkJson>[]
  • subscriptions: SubscriptionBinding[]
  • executor: WorkQueueTransactionalExecutor

  Returns Promise<void>

CheckPrerequisites

• CheckPrerequisites(): Promise<BindingValidationIssue[]>

  Database prerequisites (READ_COMMITTED_SNAPSHOT on SQL Server), reported once per transport by ValidateTopology.

  Returns Promise<BindingValidationIssue[]>

Close

• Close(): Promise<void>

  Releases the operator's independent executor. Consumers are closed by the runtime that opened them.

  Returns Promise<void>

GetBacklog

• GetBacklog(subscription: SubscriptionBinding): Promise<SubscriptionBacklog>

  Parameters

  • subscription: SubscriptionBinding

  Returns Promise<SubscriptionBacklog>

OpenConsumer

• OpenConsumer<TPayload extends WorkJson>(
      subscription: SubscriptionBinding,
  ): ITransportConsumer<TPayload>

  Type Parameters

  • TPayload extends WorkJson

  Parameters

  • subscription: SubscriptionBinding

  Returns ITransportConsumer<TPayload>

Operator

• Operator(): ITransportOperator

  Returns ITransportOperator

Publish

• Publish(
      topic: TopicBinding,
      messages: WorkMessage<WorkJson>[],
      subscriptions: SubscriptionBinding[],
      opts?: DatabasePublishOptions,
  ): Promise<PublishResult[]>

  Parameters

  • topic: TopicBinding
  • messages: WorkMessage<WorkJson>[]
  • subscriptions: SubscriptionBinding[]
  • Optionalopts: DatabasePublishOptions

  Returns Promise<PublishResult[]>

ValidateBindings

• ValidateBindings(
      topic: TopicBinding,
      subscriptions: SubscriptionBinding[],
  ): Promise<BindingValidationIssue[]>

  Parameters

  • topic: TopicBinding
  • subscriptions: SubscriptionBinding[]

  Returns Promise<BindingValidationIssue[]>