Skip to content

Commit 5be239a

Browse files
committed
Specify default values
1 parent 334ddfa commit 5be239a

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

doc/reference/reference_lua/connpool.rst

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,10 +76,14 @@ Functions
7676

7777
* ``labels`` -- the :ref:`labels <configuration_reference_labels>` an instance has.
7878
* ``roles`` -- the :ref:`roles <configuration_application_roles>` of an instance.
79-
* ``prefer_local`` -- if ``true``, ``call()`` tries to execute the specified function on a local instance. If ``false``, ``call()`` tries to connect to a random candidate until a connection is established.
79+
* ``prefer_local`` -- whether to prefer a local or remote instance to execute ``call()`` on:
80+
81+
* if ``true`` (default), ``call()`` tries to execute the specified function on a local instance.
82+
* if ``false``, ``call()`` tries to connect to a random candidate until a connection is established.
83+
8084
* ``mode`` -- a mode that allows filtering candidates based on their read-only status. This option accepts the following values:
8185

82-
* ``nil`` -- don't check the read-only status of instances.
86+
* ``nil`` (default) -- don't check the read-only status of instances.
8387
* ``ro`` -- consider only read-only instances.
8488
* ``rw`` -- consider only read-write instances.
8589
* ``prefer_ro`` -- consider read-only instances, then read-write instances.
@@ -125,7 +129,11 @@ Functions
125129
:param table/nil opts: none, any, or all of the following parameters:
126130

127131
* ``connect_timeout`` -- a connection timeout (in seconds).
128-
* ``wait_connected`` -- if ``true``, the connection is blocked until it is established. If ``false``, the connection is returned immediately.
132+
* ``wait_connected`` -- whether to block the connection until it is established:
133+
134+
* if ``true`` (default), the connection is blocked until it is established.
135+
* if ``false``, the connection is returned immediately.
136+
129137
* ``fetch_schema`` -- whether to fetch schema changes from a remote instance.
130138

131139
:return: a :ref:`net.box <net_box-module>` connection.

0 commit comments

Comments
 (0)