forked from mongodb/laravel-mongodb
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathqueues.txt
167 lines (126 loc) · 4.46 KB
/
queues.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
.. _laravel-queues:
======
Queues
======
.. facet::
:name: genre
:values: tutorial
.. 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:
.. code-block:: php
'connections' => [
'database' => [
'driver' => 'mongodb',
// You can also specify your jobs-specific database
// in the config/database.php file
'connection' => 'mongodb',
'table' => 'jobs',
'queue' => 'default',
// Optional setting
// 'retry_after' => 60,
],
],
The following table describes properties that you can specify to configure
the behavior of the queue:
.. list-table::
:header-rows: 1
:widths: 25 75
* - Setting
- Description
* - ``driver``
- **Required** Queue driver to use. The value of
this property must be ``mongodb``.
* - ``connection``
- Database connection used to store jobs. It must be a
``mongodb`` connection. The driver uses the default connection if
a connection is not specified.
* - ``table``
- **Required** Name of the MongoDB collection to
store jobs to process.
* - ``queue``
- **Required** Name of the queue.
* - ``retry_after``
- Specifies how many seconds the queue connection should wait
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
application's ``config/queue.php`` file and specify the database and
collection:
.. code-block:: php
'failed' => [
'driver' => 'mongodb',
'database' => 'mongodb',
'table' => 'failed_jobs',
],
The following table describes properties that you can specify to configure
how to handle failed jobs:
.. list-table::
:header-rows: 1
:widths: 25 75
* - Setting
- Description
* - ``driver``
- **Required** Queue driver to use. The value of
this property must be ``mongodb``.
* - ``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.
* - ``table``
- Name of the MongoDB collection to store failed
jobs. The value is ``failed_jobs`` by default.
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
------------
**Job batching** is a Laravel feature that enables you to execute a
batch of jobs and related actions before, after, and during the
execution of the jobs from the queue. To learn more about this feature,
see `Job Batching <https://laravel.com/docs/{+laravel-docs-version+}/queues#job-batching>`__
in the Laravel documentation.
In MongoDB, you don't have to create a designated collection before
using job batching. The ``job_batches`` collection is created
automatically to store metadata about your job batches, such as
their completion percentage.
To enable job batching, create the ``batching`` entry in your
application's ``config/queue.php`` file:
.. code-block:: php
'batching' => [
'driver' => 'mongodb',
'database' => 'mongodb',
'table' => 'job_batches',
],
The following table describes properties that you can specify to configure
job batching:
.. list-table::
:header-rows: 1
:widths: 25 75
* - Setting
- Description
* - ``driver``
- **Required** Queue driver to use. The value of
this property must be ``mongodb``.
* - ``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.
* - ``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:
The {+odm-short+} automatically provides the
``MongoDB\Laravel\MongoDBBusServiceProvider::class`` class as the
service provider for job batching.