You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/reference/reference_lua/connpool.rst
+11-3Lines changed: 11 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,10 +76,14 @@ Functions
76
76
77
77
* ``labels`` -- the :ref:`labels <configuration_reference_labels>` an instance has.
78
78
* ``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
+
80
84
* ``mode`` -- a mode that allows filtering candidates based on their read-only status. This option accepts the following values:
81
85
82
-
* ``nil`` -- don't check the read-only status of instances.
86
+
* ``nil`` (default) -- don't check the read-only status of instances.
83
87
* ``ro`` -- consider only read-only instances.
84
88
* ``rw`` -- consider only read-write instances.
85
89
* ``prefer_ro`` -- consider read-only instances, then read-write instances.
@@ -125,7 +129,11 @@ Functions
125
129
:param table/nil opts: none, any, or all of the following parameters:
126
130
127
131
* ``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
+
129
137
* ``fetch_schema`` -- whether to fetch schema changes from a remote instance.
130
138
131
139
:return: a :ref:`net.box <net_box-module>` connection.
0 commit comments