-
Notifications
You must be signed in to change notification settings - Fork 10.2k
Pause and purge message delivery #20284
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
1e30bfb
Added commmands to pause and resume queue delivery
maheshwarip 396a7c9
Added documentation to pause queues
maheshwarip 4a502a9
Update src/content/docs/queues/configuration/pause-purge.mdx
maheshwarip dde774a
Added documentation for purging
maheshwarip c82f484
Updated purge command
maheshwarip e6b4b2b
Fixed typos
maheshwarip 0f045a2
Improved language
maheshwarip 888cde0
Apply suggestions from code review
Oxyjun 386de7d
Update pause-purge.mdx
maheshwarip bf01386
Update commands.mdx
maheshwarip File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| --- | ||
| title: Pause and Purge | ||
| pcx_content_type: concept | ||
| sidebar: | ||
| order: 2 | ||
| --- | ||
| import { WranglerConfig, Type, MetaInfo } from "~/components"; | ||
|
|
||
| ## Pause Delivery | ||
|
|
||
| You can pause delivery of messages from your queue to any connected consumers. Pausing a queue is useful when managing downtime (for example, if your consumer Worker is unhealthy) without losing any messages. | ||
|
|
||
| Queues continue to receive and store messages even while delivery is paused. Messages in a paused queue are still subject to expiry, if the messages become older than the queue message retention period. | ||
|
|
||
| Pausing affects both [push-based consumer Workers](/queues/reference/how-queues-works#consumers) and [pull based consumers](/queues/configuration/pull-consumers). | ||
|
|
||
| ### Pause and resume delivery using Wrangler | ||
|
|
||
| The following command will pause message delivery from your queue: | ||
Oxyjun marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ```sh | ||
| $ npx run wrangler queues pause-delivery <QUEUE-NAME> | ||
| ``` | ||
|
|
||
| - `queue-name` <Type text="string" /> <MetaInfo text="required" /> | ||
| - The name of the queue for which delivery should be paused. | ||
|
|
||
| The following command will resume message delivery: | ||
|
|
||
| ```sh | ||
| $ npx run wrangler queues resume-delivery <QUEUE-NAME> | ||
| ``` | ||
|
|
||
| - `queue-name` <Type text="string" /> <MetaInfo text="required" /> | ||
| - The name of the queue for which delivery should be resumed. | ||
|
|
||
| ### What happens to HTTP Pull consumers with a paused queue? | ||
| When a queue is paused, messages cannot be pulled by an [HTTP pull based consumer](/queues/configuration/pull-consumers). Requests to pull messages will receive a `409` response, along with an error message stating `queue_delivery_paused`. | ||
|
|
||
| ## Purge queue | ||
| Purging a queue permanently deletes any messages currently stored in the Queue. Purging is useful while developing a new application, especially to clear out any test data. It can also be useful in production to handle scenarios when a batch of bad messages have been sent to a Queue. | ||
|
|
||
| Note that any in flight messages, which are currently being processed by consumers, might still be processed. Messages sent to a queue during a purge operation might not be purged. Any delayed messages will also be deleted from the queue. | ||
|
|
||
| :::caution | ||
| Purging a queue is an irreversible operation. Make sure to use this operation carefully. | ||
| ::: | ||
|
|
||
| ### Purge queue using Wrangler | ||
| The following command will purge messages from your queue. You will be prompted to enter the queue name to confirm the operation. | ||
| ```sh | ||
| $ npx run wrangler queues purge <QUEUE-NAME> | ||
|
|
||
| This operation will permanently delete all the messages in Queue <QUEUE-NAME>. Type <QUEUE-NAME> to proceed. | ||
| ``` | ||
|
|
||
| ### Does purging a Queue affect my bill? | ||
| Purging a queue counts as a single billable operation, regardless of how many messages are deleted. For example, if you purge a queue which has 100 messages, all 100 messages will be permanently deleted, and you will be billed for 1 billable operation. Refer to the [pricing](/queues/platform/pricing) page for more information about how Queues is billed. | ||
This file contains hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.