mirror of
https://github.com/django-q2/django-q2.git
synced 2026-09-15 13:37:56 +08:00
Add broker name in Schedule docs
This commit is contained in:
@@ -28,10 +28,11 @@ You can manage them through the :ref:`admin_page` or directly from your code wit
|
||||
)
|
||||
|
||||
# In case you want to use q_options
|
||||
# Specify the broker by using the property broker_name in q_options
|
||||
schedule('math.sqrt',
|
||||
9,
|
||||
hook='hooks.print_result',
|
||||
q_options={'timeout': 30},
|
||||
q_options={'timeout': 30, 'broker_name': 'broker_1'},
|
||||
schedule_type=Schedule.HOURLY)
|
||||
|
||||
# Run a schedule every 5 minutes, starting at 6 today
|
||||
@@ -117,6 +118,11 @@ Reference
|
||||
:param datetime next_run: Next or first scheduled execution datetime.
|
||||
:param dict q_options: options passed to async_task for this schedule
|
||||
:param kwargs: optional keyword arguments for the scheduled function.
|
||||
|
||||
.. note::
|
||||
|
||||
q_options does not accept the 'broker' key with a broker instance but accepts a 'broker_name' key instead. This can be used to specify the broker connection name to assign the task. If a broker with the specified name does not exist or is not running at the moment of placing the task in queue it fallbacks to the random broker/queue that handled the schedule.
|
||||
|
||||
|
||||
.. class:: Schedule
|
||||
|
||||
|
||||
Reference in New Issue
Block a user