Skip to content

Commit 3ce4de9

Browse files
committed
Fix gh-977 feedback: Module vshard
Revise info on bucket id field and shard index (cherry picked from commit 878689a)
1 parent 6604be5 commit 3ce4de9

File tree

3 files changed

+18
-10
lines changed

3 files changed

+18
-10
lines changed

doc/reference/reference_rock/vshard/vshard_admin.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -505,10 +505,11 @@ For example:
505505
box.schema.func.create('customer_add')
506506
end)
507507
508-
Every space you plan to shard must have ``bucket_id`` unsigned field indexed
509-
by ``bucket_id`` TREE index. Spaces without ``bucket_id`` index don't
510-
participate in a sharded Tarantool cluster and can be used as regular
511-
spaces if needed.
508+
.. NOTE::
509+
510+
Every space you plan to shard must have a field with
511+
:ref:`bucket id <vshard-vbuckets>` numbers, indexed by the
512+
:ref:`shard index <cfg_basic-shard_index>`.
512513

513514
.. _vshard-adding-data:
514515

doc/reference/reference_rock/vshard/vshard_architecture.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,10 +76,15 @@ multiple replica sets at a time.
7676
The total number of buckets is determined by the administrator who sets up the
7777
initial cluster configuration.
7878

79-
Every Tarantool space you plan to shard must have a bucket id field indexed by the
80-
bucket id index. Spaces without bucket id indexes do not participate in sharding
81-
but can be used as regular spaces. By default, the name of the index coincides with
82-
the bucket id.
79+
Every space you plan to shard must have a numeric field containing bucket id-s.
80+
This field must comply with the following requirements:
81+
82+
* The field's data type can be: unsigned, number or integer.
83+
* The field must be not nullable.
84+
* The field must be indexed by the :ref:`shard_index <cfg_basic-shard_index>`.
85+
The default name for this index is ``bucket_id``.
86+
87+
See the :ref:`configuration example <vshard-define-spaces>`.
8388

8489
.. _vshard-structure:
8590

doc/reference/reference_rock/vshard/vshard_ref.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,12 @@ Basic parameters
4646

4747
.. confval:: shard_index
4848

49-
An index over the bucket id.
49+
Name of a TREE index over the :ref:`bucket id <vshard-vbuckets>`.
50+
Spaces without this index do not participate in a sharded Tarantool
51+
cluster and can be used as regular spaces if needed.
5052

5153
| Type: non-empty string or non-negative integer
52-
| Default: coincides with the bucket id number
54+
| Default: "bucket_id"
5355
| Dynamic: no
5456
5557
.. _cfg_basic-bucket_count:

0 commit comments

Comments
 (0)