Skip to content
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

DOCSP-42020: queues feedback 5.0 #3222

Merged
merged 4 commits into from
Dec 2, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 27 additions & 18 deletions docs/queues.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@ Queues
.. meta::
:keywords: php framework, odm, code example, jobs

Overview
--------

In this guide, you can learn how to use MongoDB as your database for
Laravel Queue. Laravel Queue allows you to create queued jobs that are
processed in the background.

Configuration
-------------

To use MongoDB as your database for Laravel Queue, change
the driver in your application's ``config/queue.php`` file:

Expand All @@ -22,7 +32,7 @@ the driver in your application's ``config/queue.php`` file:
// You can also specify your jobs-specific database
// in the config/database.php file
'connection' => 'mongodb',
'collection' => 'jobs',
'table' => 'jobs',
'queue' => 'default',
// Optional setting
// 'retry_after' => 60,
Expand All @@ -48,7 +58,7 @@ the behavior of the queue:
``mongodb`` connection. The driver uses the default connection if
a connection is not specified.

* - ``collection``
* - ``table``
- **Required** Name of the MongoDB collection to
store jobs to process.

Expand All @@ -60,7 +70,7 @@ the behavior of the queue:
before retrying a job that is being processed. The value is
``60`` by default.

To use MongoDB to handle failed jobs, create a ``failed`` entry in your
To use MongoDB to handle *failed jobs*, create a ``failed`` entry in your
application's ``config/queue.php`` file and specify the database and
collection:

Expand All @@ -69,7 +79,7 @@ collection:
'failed' => [
'driver' => 'mongodb',
'database' => 'mongodb',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace connection with database in the table.

'collection' => 'failed_jobs',
'table' => 'failed_jobs',
],

The following table describes properties that you can specify to configure
Expand All @@ -86,21 +96,20 @@ how to handle failed jobs:
- **Required** Queue driver to use. The value of
this property must be ``mongodb``.

* - ``connection``
* - ``database``
- Database connection used to store jobs. It must be
a ``mongodb`` connection. The driver uses the default connection
if a connection is not specified.

* - ``collection``
* - ``table``
- Name of the MongoDB collection to store failed
jobs. The value is ``failed_jobs`` by default.

Then, add the service provider in your application's
``config/app.php`` file:

.. code-block:: php

MongoDB\Laravel\MongoDBQueueServiceProvider::class,
To register failed jobs, you can use the default failed
job provider from Laravel. To learn more, see
`Dealing With Failed Jobs
<https://laravel.com/docs/{+laravel-docs-version+}/queues#dealing-with-failed-jobs>`__ in
the Laravel documentation on Queues.

Job Batching
------------
Expand All @@ -124,7 +133,7 @@ application's ``config/queue.php`` file:
'batching' => [
'driver' => 'mongodb',
'database' => 'mongodb',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also for job batching, replace connection with database.

'collection' => 'job_batches',
'table' => 'job_batches',
],

The following table describes properties that you can specify to configure
Expand All @@ -141,18 +150,18 @@ job batching:
- **Required** Queue driver to use. The value of
this property must be ``mongodb``.

* - ``connection``
* - ``database``
- Database connection used to store jobs. It must be a
``mongodb`` connection. The driver uses the default connection if
a connection is not specified.

* - ``collection``
* - ``table``
- Name of the MongoDB collection to store job
batches. The value is ``job_batches`` by default.

Then, add the service provider in your application's ``config/app.php``
file:

.. code-block:: php

MongoDB\Laravel\MongoDBBusServiceProvider::class,
The {+odm-short+} automatically provides the
``MongoDB\Laravel\MongoDBBusServiceProvider::class`` class as the
service provider for job batching.