Zen

Source string Source string

498/10000 · 498
English Actions
:ref:`vshard.storage.bucket_collect(bucket_id) <storage_api-bucket_collect>`
:ref:`vshard.storage.bucket_force_create(first_bucket_id, count) <storage_api-bucket_force_create>`
:ref:`vshard.storage.bucket_force_drop(bucket_id, to) <storage_api-bucket_force_drop>`
:ref:`vshard.storage.bucket_send(bucket_id, to) <storage_api-bucket_send>`
:ref:`vshard.storage.buckets_discovery() <storage_api-buckets_discovery>`
:ref:`vshard.storage.rebalancer_request_state() <storage_api-rebalancer_request_state>`
Storage public API
Configure the database and start sharding for the specified ``storage`` instance.
Parameters
a ``storage`` configuration
UUID of the instance
Return information about the storage instance. Since vshard v.0.1.22, the function also accepts options, which can be used to get additional information.
* ``with_services`` — a bool value. If set to ``true``, the function returns information about the background services (such as garbage collector, rebalancer, recovery, or applier of the routes) that are working on the current instance. See :ref:`vshard.router.info <router_api-info>` for detailed reference.
``with_services`` — a bool value. If set to ``true``, the function returns information about the background services (such as garbage collector, rebalancer, recovery, or applier of the routes) that are working on the current instance. See :ref:`vshard.router.info <router_api-info>` for detailed reference.
**Example:**
tarantool> vshard.storage.info()
---
- replicasets:
c862545d-d966-45ff-93ad-763dce4a9723:
uuid: c862545d-d966-45ff-93ad-763dce4a9723
master:
uri: admin@localhost:3302
1990be71-f06e-4d9a-bcf9-4514c4e0c889:
uuid: 1990be71-f06e-4d9a-bcf9-4514c4e0c889
master:
uri: admin@localhost:3304
bucket:
receiving: 0
active: 15000
total: 15000
garbage: 0
pinned: 0
sending: 0
status: 0
replication:
status: master
alerts: []
...
Call the specified function on the current ``storage`` instance.
a bucket identifier
a type of the function: 'read' or 'write'
function to execute
array of the function's arguments
Return
The original return value of the executed function, or ``nil`` and error object.
Wait until the dataset is synchronized on replicas.
a timeout, in seconds
return
``true`` if the dataset was synchronized successfully; or ``nil`` and ``err`` explaining why the dataset cannot be synchronized.
Pin a bucket to a replica set. A pinned bucket cannot be moved even if it breaks the cluster balance.
``true`` if the bucket is pinned successfully; or ``nil`` and ``err`` explaining why the bucket cannot be pinned
Return a pinned bucket back into the active state.
``true`` if the bucket is unpinned successfully; or ``nil`` and ``err`` explaining why the bucket cannot be unpinned

Loading…

User avatar None

New source string

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

tarantool> vshard.storage.info()
---
- replicasets:
c862545d-d966-45ff-93ad-763dce4a9723:
uuid: c862545d-d966-45ff-93ad-763dce4a9723
master:
uri: admin@localhost:3302
1990be71-f06e-4d9a-bcf9-4514c4e0c889:
uuid: 1990be71-f06e-4d9a-bcf9-4514c4e0c889
master:
uri: admin@localhost:3304
bucket:
receiving: 0
active: 15000
total: 15000
garbage: 0
pinned: 0
sending: 0
status: 0
replication:
status: master
alerts: []
...
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 43