Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BlobCheckpointStore

Package version

An implementation of CheckpointStore that uses Azure Blob Storage to persist checkpoint data.

class

Hierarchy

  • BlobCheckpointStore

Implements

  • any

Index

Constructors

Methods

Constructors

constructor

Methods

claimOwnership

  • claimOwnership(partitionOwnership: PartitionOwnership[]): Promise<PartitionOwnership[]>

  • Claim ownership of a list of partitions. This will return the list of partitions that were successfully claimed.

    Parameters

    • partitionOwnership: PartitionOwnership[]

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

    Returns Promise<PartitionOwnership[]>

    A list 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[]>

  • Get the list of all existing partition ownership from the underlying data store. May return empty results if there are is no existing ownership information. Partition Ownership contains the information on which EventHubConsumerClient subscribe call is currently processing the partition.

    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[]>

    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

    • checkpoint: Checkpoint

      The checkpoint.

    Returns Promise<void>

    The new etag on successful update.

Generated using TypeDoc