Skip to content

Commit

Permalink
Add broker name in Schedule docs
Browse files Browse the repository at this point in the history
  • Loading branch information
telmobarros committed Feb 11, 2021
1 parent 1d6d996 commit c838fa8
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/schedules.rst
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit c838fa8

Please sign in to comment.