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

Merge 4.8 into 5.0 #3252

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
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
39 changes: 23 additions & 16 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',
'collection' => 'failed_jobs',
'table' => 'failed_jobs',
],

The following table describes properties that you can specify to configure
Expand All @@ -91,16 +101,13 @@ how to handle failed jobs:
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,
The {+odm-short+} automatically provides the
``MongoDB\Laravel\MongoDBQueueServiceProvider::class`` class as the
service provider to handle failed jobs.

Job Batching
------------
Expand All @@ -124,7 +131,7 @@ application's ``config/queue.php`` file:
'batching' => [
'driver' => 'mongodb',
'database' => 'mongodb',
'collection' => 'job_batches',
'table' => 'job_batches',
],

The following table describes properties that you can specify to configure
Expand All @@ -146,13 +153,13 @@ job batching:
``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.
9 changes: 7 additions & 2 deletions docs/transactions.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ In this guide, you can learn how to perform a **transaction** in MongoDB by
using {+odm-long+}. Transactions let you run a sequence of write operations
that update the data only after the transaction is committed.

If the transaction fails, the {+php-library+} that manages MongoDB operations
for the {+odm-short+} ensures that MongoDB discards all the changes made within
If the transaction fails, the {+php-library+}, which manages MongoDB operations
for the {+odm-short+}, ensures that MongoDB discards all the changes made within
the transaction before they become visible. This property of transactions
that ensures that all changes within a transaction are either applied or
discarded is called **atomicity**.
Expand Down Expand Up @@ -74,15 +74,20 @@ MongoDB Server and the {+odm-short+} have the following limitations:
you perform write operations in a transaction. To learn more about this
limitation, see :manual:`Create Collections and Indexes in a Transaction </core/transactions/#create-collections-and-indexes-in-a-transaction>`
in the {+server-docs-name+}.

- MongoDB does not support nested transactions. If you attempt to start a
transaction within another one, the extension raises a ``RuntimeException``.
To learn more about this limitation, see :manual:`Transactions and Sessions </core/transactions/#transactions-and-sessions>`
in the {+server-docs-name+}.

- {+odm-long+} does not support the database testing traits
``Illuminate\Foundation\Testing\DatabaseTransactions`` and ``Illuminate\Foundation\Testing\RefreshDatabase``.
As a workaround, you can create migrations with the ``Illuminate\Foundation\Testing\DatabaseMigrations``
trait to reset the database after each test.

- {+odm-long+} does not support running parallel operations within a
single transaction.

.. _laravel-transaction-callback:

Run a Transaction in a Callback
Expand Down
Loading