Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CheckpointStore

Package version

A checkpoint store stores and retrieves partition ownership information and checkpoint details for each partition in a given consumer group of an event hub instance.

Users are not meant to implement an CheckpointStore. Users are expected to choose existing implementations of this interface, instantiate it, and pass it to the EventHubConsumerClient class constructor when instantiating a client. Users are not expected to use any of the methods on a checkpoint store, these are used internally by the client.

Implementations of CheckpointStore can be found on npm by searching for packages with the prefix @azure/eventhub-checkpointstore-.

Hierarchy

  • CheckpointStore

Index

Methods

Methods

claimOwnership

  • Called to claim ownership of a list of partitions. This will return the list of partitions that were owned successfully.

    Parameters

    • partitionOwnership: PartitionOwnership[]

      The list of partition ownership this instance is claiming to own.

    Returns Promise<PartitionOwnership[]>

    A list of partitions this instance successfully claimed ownership.

listCheckpoints

  • listCheckpoints(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string): Promise<Checkpoint[]>

  • Lists all the checkpoints in a data store for a given namespace, eventhub and consumer group.

    Parameters

    • fullyQualifiedNamespace: string

      The fully qualified Event Hubs namespace. This is likely to be similar to .servicebus.windows.net.

    • eventHubName: string

      The event hub name.

    • consumerGroup: string

      The consumer group name.

    Returns Promise<Checkpoint[]>

listOwnership

  • listOwnership(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string): Promise<PartitionOwnership[]>

  • Called to get the list of all existing partition ownership from the underlying data store. Could return empty results if there are is no existing ownership information.

    Parameters

    • fullyQualifiedNamespace: string

      The fully qualified Event Hubs namespace. This is likely to be similar to .servicebus.windows.net.

    • eventHubName: string

      The event hub name.

    • consumerGroup: string

      The consumer group name.

    Returns Promise<PartitionOwnership[]>

    A list of partition ownership details of all the partitions that have/had an owner.

updateCheckpoint

  • updateCheckpoint(checkpoint: Checkpoint): Promise<void>

  • Updates the checkpoint in the data store for a partition.

    Parameters

    Returns Promise<void>

Generated using TypeDoc