renamed checkpoint by batch samples to by event count (Azure#15977)

* renamed checkpoint by batch samples to by event count * change link in EH sample readme for event count sample
AzureSDKAutomation · Jan 5, 2021 · a6e0a61 · a6e0a61
1 parent 1e453ab
commit a6e0a61
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 7 deletions.
diff --git a/sdk/eventhub/azure-eventhub/samples/README.md b/sdk/eventhub/azure-eventhub/samples/README.md
@@ -40,7 +40,7 @@ Both [sync version](https://github.com/Azure/azure-sdk-for-python/tree/master/sd
 - [recv_with_checkpoint_store.py](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/eventhub/azure-eventhub/samples/sync_samples/recv_with_checkpoint_store.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/eventhub/azure-eventhub/samples/async_samples/recv_with_checkpoint_store_async.py)) - Examples to receive events and do checkpoint using blob checkpoint store:
     - Receive events and do checkpoint using blob checkpoint store
 
-- [recv_with_checkpoint_by_batch.py](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/eventhub/azure-eventhub/samples/sync_samples/recv_with_checkpoint_by_batch.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/eventhub/azure-eventhub/samples/async_samples/recv_with_checkpoint_by_batch_async.py)) - Examples to receive events and do checkpoint by batch using blob checkpoint store:
+- [recv_with_checkpoint_by_event_count.py](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/eventhub/azure-eventhub/samples/sync_samples/recv_with_checkpoint_by_event_count.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/eventhub/azure-eventhub/samples/async_samples/recv_with_checkpoint_by_event_count_async.py)) - Examples to receive events and do checkpoint by event count using blob checkpoint store:
     - Receive events and do checkpoint every fixed amount of events (e.g. checkpoint every 20 events) using blob checkpoint store
 
 - [receive_batch_with_checkpoint.py](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/eventhub/azure-eventhub/samples/sync_samples/receive_batch_with_checkpoint.py) ([async_version](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/eventhub/azure-eventhub/samples/async_samples/receive_batch_with_checkpoint_async.py)) - Examples to receive events in batches and do checkpoint by the batch:

diff --git a/...es/recv_with_checkpoint_by_batch_async.py → ...v_with_checkpoint_by_event_count_async.py b/...es/recv_with_checkpoint_by_batch_async.py → ...v_with_checkpoint_by_event_count_async.py
@@ -6,7 +6,8 @@
 # --------------------------------------------------------------------------------------------
 
 """
-An example to show receiving events from an Event Hub with checkpoint store doing checkpoint by batch asynchronously.
+An example to show receiving events from an Event Hub with checkpoint store doing checkpoint
+by every fixed event count asynchronously.
 In the `receive` method of `EventHubConsumerClient`:
 If no partition id is specified, the checkpoint_store are used for load-balance and checkpoint.
 If partition id is specified, the checkpoint_store can only be used for checkpoint.
@@ -23,15 +24,15 @@
 BLOB_CONTAINER_NAME = "your-blob-container-name"  # Please make sure the blob container resource exists.
 
 partition_recv_cnt_since_last_checkpoint = defaultdict(int)
-checkpoint_batch_event_cnt = 20
+checkpoint_event_cnt = 20
 
 
 async def on_event(partition_context, event):
     # Put your code here.
     p_id = partition_context.partition_id
     print("Received event from partition: {}.".format(p_id))
     partition_recv_cnt_since_last_checkpoint[p_id] += 1
-    if partition_recv_cnt_since_last_checkpoint[p_id] >= checkpoint_batch_event_cnt:
+    if partition_recv_cnt_since_last_checkpoint[p_id] >= checkpoint_event_cnt:
         await partition_context.update_checkpoint(event)
         partition_recv_cnt_since_last_checkpoint[p_id] = 0
 

diff --git a/..._samples/recv_with_checkpoint_by_batch.py → ...es/recv_with_checkpoint_by_event_count.py b/..._samples/recv_with_checkpoint_by_batch.py → ...es/recv_with_checkpoint_by_event_count.py
@@ -6,7 +6,8 @@
 # --------------------------------------------------------------------------------------------
 
 """
-An example to show receiving events from an Event Hub with checkpoint store doing checkpoint by batch.
+An example to show receiving events from an Event Hub with checkpoint store doing checkpoint
+by every fixed event count.
 In the `receive` method of `EventHubConsumerClient`:
 If no partition id is specified, the checkpoint_store are used for load-balance and checkpoint.
 If partition id is specified, the checkpoint_store can only be used for checkpoint.
@@ -22,7 +23,7 @@
 BLOB_CONTAINER_NAME = "your-blob-container-name"  # Please make sure the blob container resource exists.
 
 partition_recv_cnt_since_last_checkpoint = defaultdict(int)
-checkpoint_batch_event_cnt = 20
+checkpoint_event_cnt = 20
 
 
 def on_event(partition_context, event):
@@ -31,7 +32,7 @@ def on_event(partition_context, event):
     p_id = partition_context.partition_id
     print("Received event from partition: {}".format(p_id))
     partition_recv_cnt_since_last_checkpoint[p_id] += 1
-    if partition_recv_cnt_since_last_checkpoint[p_id] >= checkpoint_batch_event_cnt:
+    if partition_recv_cnt_since_last_checkpoint[p_id] >= checkpoint_event_cnt:
         partition_context.update_checkpoint(event)
         partition_recv_cnt_since_last_checkpoint[p_id] = 0