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

Update docs for queue section #3223

Closed
wants to merge 1 commit into from
Closed
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
17 changes: 5 additions & 12 deletions docs/queues.txt
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ collection:
'failed' => [
'driver' => 'mongodb',
'database' => 'mongodb',
'collection' => 'failed_jobs',
'table' => 'failed_jobs',
],

The following table describes properties that you can specify to configure
Expand All @@ -86,22 +86,15 @@ 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.

Comment on lines 88 to 97
Copy link
Contributor Author

Choose a reason for hiding this comment

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

according to the registerFailedJobServices method in the QueueServiceProvider class, the keys must be database and table instead of connections and collection.

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

.. code-block:: php

MongoDB\Laravel\MongoDBQueueServiceProvider::class,

Comment on lines -98 to -104
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Since it's removed in #3122

Job Batching
------------

Expand Down Expand Up @@ -141,12 +134,12 @@ 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.

Expand Down