Zen

Source string Source string

271/10000 · 271
English Actions
:ref:`replicaset_object:callrw() <router_api-replicaset_callrw>`
:ref:`replicaset_object:callre() <router_api-replicaset_callre>`
:ref:`Router internal API <vshard_api_reference-router_internal_api>`
:ref:`vshard.router.bucket_discovery(bucket_id) <router_api-bucket_discovery>`
Router public API
Perform the initial cluster bootstrap and distribute all buckets across the replica sets.
Parameters
a number of seconds before ending a bootstrap attempt as unsuccessful. Recreate the cluster in case of bootstrap timeout.
by default is set to ``false`` that means raise an error, when the cluster is already bootstrapped. ``True`` means consider an already bootstrapped cluster a success.
**Example:**
vshard.router.bootstrap({timeout = 4, if_not_bootstrapped = true})
To detect whether a cluster is bootstrapped, ``vshard`` looks for at least one bucket in the whole cluster. If the cluster was bootstrapped only partially (for example, due to an error during the first bootstrap), then it will be considered a bootstrapped cluster on a next bootstrap call with ``if_not_bootstrapped``. So this is still a bad practice. Avoid calling ``bootstrap()`` multiple times.
Configure the database and start sharding for the specified ``router`` instance. See the :ref:`sample configuration <vshard-config-cluster-example>`.
a configuration table
Create a new router instance. ``vshard`` supports multiple routers in a single Tarantool instance. Each router can be connected to any ``vshard`` cluster, and multiple routers can be connected to the same cluster.
A router created via ``vshard.router.new()`` works in the same way as a static router, but the method name is preceded by a colon (``vshard.router:method_name(...)``), while for a static router the method name is preceded by a period (``vshard.router.method_name(...)``).
A static router can be obtained via the ``vshard.router.static()`` method and then used like a router created via the ``vshard.router.new()`` method.
``box.cfg`` is shared among all the routers of a single instance.
a router instance name. This name is used as a prefix in logs of the router and must be unique within the instance
a configuration table. See the :ref:`sample configuration <vshard-config-cluster-example>`.
Return
a router instance, if created successfully; otherwise, nil and an error object
Call the function identified by function-name on the shard storing the bucket identified by bucket_id. See the :ref:`Processing requests <vshard-process-requests>` section for details on function operation.
a bucket identifier
either a string = 'read'|'write', or a map with mode='read'|'write' and/or prefer_replica=true|false and/or balance=true|false.
a function to execute
an array of the function's arguments
* ``timeout`` — a request timeout, in seconds. If the ``router`` cannot identify a shard with the specified ``bucket_id``, it will retry until the timeout is reached. * other :ref:`net.box options <net_box-options>`, such as ``is_async``, ``buffer``, ``on_push`` are also supported.
``timeout`` — a request timeout, in seconds. If the ``router`` cannot identify a shard with the specified ``bucket_id``, it will retry until the timeout is reached.
other :ref:`net.box options <net_box-options>`, such as ``is_async``, ``buffer``, ``on_push`` are also supported.
The mode parameter has two possible forms: a string or a map. Examples of the string form are: ``'read'``, ``'write'``. Examples of the map form are: ``{mode='read'}``, ``{mode='write'}``, ``{mode='read', prefer_replica=true}``, ``{mode='read', balance=true}``, ``{mode='read', prefer_replica=true, balance=true}``.

Loading…

User avatar None

New source string

testing_project / Documentation: reference/reference_rock/vshard/vshard_router — English

A router created via ``vshard.router.new()`` works in the same way as a static router, but the method name is preceded by a colon (``vshard.router:method_name(...)``), while for a static router the method name is preceded by a period (``vshard.router.method_name(...)``).
a year ago
Browse all string changes

Things to check

Ellipsis

The string uses three dots (...) instead of an ellipsis character (…)

Reset

Glossary

English English
No related strings found in the glossary.

String information

Flags
read-only
String age
a year ago
Last updated
a year ago
Source string age
a year ago
Translation file
string 44