[Python] data subscription pages batch [Replace C# samples] #1865
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
poissoncorp
reviewed
Jul 9, 2024
| | Member | Type | Description | | ||
| |--------|:-----|-------------| | ||
| | **subscription_name** | `str` | Returns the subscription name passed to the constructor. This name will be used by the server side to identify the subscription. | | ||
| | **time_to_wait_before_connection_retry** | `DateTime` | Time to wait before reconnecting, in the case of non-aborting failure during the subscription processing.<br>Default: 5 seconds. | |
There was a problem hiding this comment.
Suggested change
| | **time_to_wait_before_connection_retry** | `DateTime` | Time to wait before reconnecting, in the case of non-aborting failure during the subscription processing.<br>Default: 5 seconds. | | |
| | **time_to_wait_before_connection_retry** | `timedelta` | Time to wait before reconnecting, in the case of non-aborting failure during the subscription processing.<br>Default: 5 seconds. | | |
poissoncorp
reviewed
Jul 9, 2024
| After [generating](../../../client-api/data-subscriptions/consumption/api-overview#subscription-worker-generation) | ||
| a subscription worker, the worker doesn't process any documents yet. | ||
| Processing starts when the `run` function is called. | ||
| The `run` function receives the client-side code as a delegate that will process the retrieved batches: |
There was a problem hiding this comment.
Suggested change
| The `run` function receives the client-side code as a delegate that will process the retrieved batches: | |
| The `run` function receives the client-side code as a function that will process the retrieved batches: | |
poissoncorp
reviewed
Jul 9, 2024
| node is currently responsible for data subscriptions. | ||
| {NOTE/} | ||
|
|
||
| | `SubscriptionBatch[_T].item` Member | Type | Description | |
There was a problem hiding this comment.
Suggested change
| | `SubscriptionBatch[_T].item` Member | Type | Description | | |
| | `SubscriptionBatch[_T].Item` Member | Type | Description | | |
poissoncorp
reviewed
Jul 9, 2024
|
|
||
| | Method | Return Type | Description | | ||
| |--------|:-----|-------------| | ||
| | `dispose` | `void` | Aborts subscription worker operation ungracefully by waiting for the task returned by the `run` function to finish running. | |
There was a problem hiding this comment.
Suggested change
| | `dispose` | `void` | Aborts subscription worker operation ungracefully by waiting for the task returned by the `run` function to finish running. | | |
| | `close(bool wait_for_subscription_task = True)` | `void` | Aborts subscription worker operation ungracefully by waiting for the task returned by the `run` function to finish running. | | |
poissoncorp
reviewed
Jul 9, 2024
| | Method | Return Type | Description | | ||
| |--------|:-----|-------------| | ||
| | `dispose` | `void` | Aborts subscription worker operation ungracefully by waiting for the task returned by the `run` function to finish running. | | ||
| | `dispose(bool waitForSubscriptionTask)` | `void` | Aborts the subscription worker, but allows deciding whether to wait for the `run` function task or not. | |
There was a problem hiding this comment.
Suggested change
| | `dispose(bool waitForSubscriptionTask)` | `void` | Aborts the subscription worker, but allows deciding whether to wait for the `run` function task or not. | |
poissoncorp
reviewed
Jul 9, 2024
| |--------|:-----|-------------| | ||
| | `dispose` | `void` | Aborts subscription worker operation ungracefully by waiting for the task returned by the `run` function to finish running. | | ||
| | `dispose(bool waitForSubscriptionTask)` | `void` | Aborts the subscription worker, but allows deciding whether to wait for the `run` function task or not. | | ||
| | `run` | `Task` | Starts the subscription worker work of processing batches, receiving the batch processing delegates (see [above](../../../client-api/data-subscriptions/consumption/api-overview#running-subscription-worker)). | |
There was a problem hiding this comment.
Suggested change
| | `run` | `Task` | Starts the subscription worker work of processing batches, receiving the batch processing delegates (see [above](../../../client-api/data-subscriptions/consumption/api-overview#running-subscription-worker)). | | |
| | `run` | `Future[None]` | Starts the subscription worker work of processing batches, receiving the batch processing delegates (see [above](../../../client-api/data-subscriptions/consumption/api-overview#running-subscription-worker)). | | |
poissoncorp
reviewed
Jul 9, 2024
|
|
||
| | Event | Type\Return type | Description | | ||
| |--------|:-----|-------------| | ||
| | **after\_acknowledgment** | `AfterAcknowledgmentAction` (event) | Event invoked after each time the server acknowledges batch processing progress. | |
There was a problem hiding this comment.
Suggested change
| | **after\_acknowledgment** | `AfterAcknowledgmentAction` (event) | Event invoked after each time the server acknowledges batch processing progress. | | |
| | **after\_acknowledgment** | `Callable[[SubscriptionBatch[_T]], None]` | Event invoked after each time the server acknowledges batch processing progress. | | |
poissoncorp
reviewed
Jul 9, 2024
| |--------|:-----|-------------| | ||
| | **after\_acknowledgment** | `AfterAcknowledgmentAction` (event) | Event invoked after each time the server acknowledges batch processing progress. | | ||
|
|
||
| | `AfterAcknowledgmentAction` Parameters | | | |
There was a problem hiding this comment.
maybe
Suggested change
| | `AfterAcknowledgmentAction` Parameters | | | | |
| | `Callable[[SubscriptionBatch[_T]], None]` Parameters | | | | |
but better
Suggested change
| | `AfterAcknowledgmentAction` Parameters | | | | |
| | `after_acknowledgment` Parameters | | | | |
There was a problem hiding this comment.
done (the second one :o)
poissoncorp
reviewed
Jul 9, 2024
|
|
||
| | Return value | | | ||
| | ------------- | ----- | | ||
| | `Task` | The worker waits for the task to finish the event processing | |
There was a problem hiding this comment.
Suggested change
| | `Task` | The worker waits for the task to finish the event processing | | |
| | `Future[None]` | The worker waits for the task to finish the event processing | | |
poissoncorp
reviewed
Jul 9, 2024
| The task returned by the `run` function will be terminated with an erroneous state, throwing | ||
| a `SubscriberErrorException` exception. | ||
|
|
||
| * If `SubscriptionWorkerOptions`'s value `IgnoreSubscriberErrors` is set to True, the erroneous |
There was a problem hiding this comment.
Suggested change
| * If `SubscriptionWorkerOptions`'s value `IgnoreSubscriberErrors` is set to True, the erroneous | |
| * If `SubscriptionWorkerOptions`'s value `ignore_subscriber_errors` is set to True, the erroneous |
poissoncorp
reviewed
Jul 9, 2024
| The above cases describe situations in which a worker tries to reconnect with the server. | ||
| There are two key `SubscriptionWorkerOptions` fields controlling this state: | ||
|
|
||
| * `TimeToWaitBeforeConnectionRetry` - Worker 'sleep' period before trying to reconnect. |
There was a problem hiding this comment.
Suggested change
| * `TimeToWaitBeforeConnectionRetry` - Worker 'sleep' period before trying to reconnect. | |
| * `time_to_wait_before_connection_retry` - Worker 'sleep' period before trying to reconnect. |
poissoncorp
reviewed
Jul 9, 2024
| There are two key `SubscriptionWorkerOptions` fields controlling this state: | ||
|
|
||
| * `TimeToWaitBeforeConnectionRetry` - Worker 'sleep' period before trying to reconnect. | ||
| * `MaxErroneousPeriod` - Maximum time that the worker is allowed to be in an erroneous state. |
There was a problem hiding this comment.
Suggested change
| * `MaxErroneousPeriod` - Maximum time that the worker is allowed to be in an erroneous state. | |
| * `max_erroneous_period` - Maximum time that the worker is allowed to be in an erroneous state. |
poissoncorp
reviewed
Jul 9, 2024
| {INFO/} | ||
|
|
||
| {INFO: OnUnexpectedSubscriptionError} | ||
| `OnUnexpectedSubscriptionError` is the event raised when a connection failure occurs |
There was a problem hiding this comment.
Suggested change
| `OnUnexpectedSubscriptionError` is the event raised when a connection failure occurs | |
| `on_unexpected_subscription_error` is the event raised when a connection failure occurs |
poissoncorp
suggested changes
Jul 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
RDoc-2925 Data subscriptions > Creation > How to create data subscription
RDoc-2917 Data subscriptions > Creation > Examples
RDoc-2918 Data subscriptions > Creation > API overview
RDoc-2919 Data subscriptions > Consumption > How to consume
RDoc-2920 Data subscriptions > Consumption > Examples
RDoc-2921 Data subscriptions > Consumption > API overview