Skip to content

Commit 62991aa

Browse files
committed
Update docs
1 parent 642b6b5 commit 62991aa

2 files changed

Lines changed: 10 additions & 2 deletions

File tree

packages/azure/_dev/build/docs/events.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -573,7 +573,11 @@ Possible values are `earliest` and `latest`.
573573

574574
`migrate_checkpoint` :
575575
_boolean_
576-
(processor v2 only) Controls processor behavior upon the initial transition from v1 to v2. Defaults to `true`, which means the processor will attempt to migrate checkpoint information from the v1 format to v2. If set to `false`, the processor will bypass existing v1 checkpoints and replay all available events in the Event Hub from the start of the retention window. For example, if set to `false` on an Event Hub with a 1-hour retention period, the processor will replay the last hour's worth of data.
576+
(processor v2 only) Controls processor behavior upon the initial transition from v1 to v2. If you are starting directly with v2, you can disregard this setting.
577+
578+
Defaults to `true`, which means the processor will automatically migrate checkpoint information from the v1 format to v2.
579+
580+
If set to `false`, the processor will bypass existing v1 checkpoints and replay all events in the Event Hub from the start of the retention window. For example, if set to `false` on an Event Hub with a 1-hour retention period, the processor will replay the last hour's worth of data.
577581

578582
`endpoint_suffix` :
579583
_string_

packages/azure/docs/events.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -573,7 +573,11 @@ Possible values are `earliest` and `latest`.
573573

574574
`migrate_checkpoint` :
575575
_boolean_
576-
(processor v2 only) Controls processor behavior upon the initial transition from v1 to v2. Defaults to `true`, which means the processor will attempt to migrate checkpoint information from the v1 format to v2. If set to `false`, the processor will bypass existing v1 checkpoints and replay all available events in the Event Hub from the start of the retention window. For example, if set to `false` on an Event Hub with a 1-hour retention period, the processor will replay the last hour's worth of data.
576+
(processor v2 only) Controls processor behavior upon the initial transition from v1 to v2. If you are starting directly with v2, you can disregard this setting.
577+
578+
Defaults to `true`, which means the processor will automatically migrate checkpoint information from the v1 format to v2.
579+
580+
If set to `false`, the processor will bypass existing v1 checkpoints and replay all events in the Event Hub from the start of the retention window. For example, if set to `false` on an Event Hub with a 1-hour retention period, the processor will replay the last hour's worth of data.
577581

578582
`endpoint_suffix` :
579583
_string_

0 commit comments

Comments
 (0)