From c838fa82e4a1142dac737daa3d05c866f28e1ee9 Mon Sep 17 00:00:00 2001 From: Telmo Barros Date: Thu, 11 Feb 2021 13:04:00 +0000 Subject: [PATCH] Add broker name in Schedule docs --- docs/schedules.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/schedules.rst b/docs/schedules.rst index 9d4e5fe..d0fe81d 100644 --- a/docs/schedules.rst +++ b/docs/schedules.rst @@ -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