Skip to content
Snippets Groups Projects
Commit 9417505f authored by Alexander Tolstoy's avatar Alexander Tolstoy
Browse files

provide Vshard config details in a concealed part

parent 77eadd28
No related branches found
No related tags found
1 merge request!551architecture: update RPC API
Pipeline #51658 passed
...@@ -31,18 +31,18 @@ RPC API используется в следующих сценариях: ...@@ -31,18 +31,18 @@ RPC API используется в следующих сценариях:
### Особенности энкодинга {: #proc_encoding } ### Особенности энкодинга {: #proc_encoding }
- `optional` поле (например `optional MP_INT`) отличается от обычного тем, - `optional`-поле (например `optional MP_INT`) отличается от обычного тем,
что на его месте может присутствовать как ожидаемый msgpack тип (`MP_INT`), что на его месте может присутствовать как ожидаемый msgpack-тип (`MP_INT`),
так и `MP_NIL`. Тем не менее, при формировании запроса, нельзя пропускать так и `MP_NIL`. Тем не менее, при формировании запроса, нельзя пропускать
это поле. При отсутсвии значения, всегда должен быть указан `MP_NIL` это поле. При отсутствии значения всегда должен быть указан `MP_NIL`.
- в случае успешного выполнения RPC фунцкии (`IPROTO_OK`) возвращаемое msgpack - в случае успешного выполнения RPC-функции (`IPROTO_OK`) возвращаемое
значение всегда дополнительно обернуто в `MP_ARRAY` msgpack-значение всегда дополнительно обернуто в `MP_ARRAY`.
- в случае ошибки выполения RPC функции (`Result::Err` в терминах Rust) в ответе - в случае ошибки выполнения RPC-функции (`Result::Err` в терминах Rust) в ответе
будет iproto сообщение с типом `IPROTO_TYPE_ERROR` содержащее в себе будет iproto-сообщение с типом `IPROTO_TYPE_ERROR`, содержащее в себе
[описание](https://www.tarantool.io/en/doc/latest/dev_guide/internals/iproto/format/#error-responses) [описание](https://www.tarantool.io/en/doc/latest/dev_guide/internals/iproto/format/#error-responses)
ошибки ошибки.
### Привилегии {: #proc_privileges } ### Привилегии {: #proc_privileges }
...@@ -91,10 +91,10 @@ fn proc_sql_dispatch(pattern, params, id, traceable) -> Result ...@@ -91,10 +91,10 @@ fn proc_sql_dispatch(pattern, params, id, traceable) -> Result
Аргументы: Аргументы:
- `pattern`: (MP_STR) запрос SQL - `pattern`: (MP_STR) запрос SQL
- `params`: (MP_ARRAY) параметры для подставления в `pattern` в случае - `params`: (MP_ARRAY) параметры для использования в `pattern` в случае
[параметризованного запроса][parametrization] [параметризованного запроса][parametrization]
- `id`: (optional MP_STR) id SQL запроса, - `id`: (optional MP_STR) id SQL запроса,
используется для идентификции запроса в таблицах статистики используется для идентификации запроса в таблицах статистики
- `traceable`: (optional MP_BOOL) включение отслеживания статистики запроса. - `traceable`: (optional MP_BOOL) включение отслеживания статистики запроса.
запрос попадет в таблицы статистики с вероятностью 1% при `false` и 100% при `true` запрос попадет в таблицы статистики с вероятностью 1% при `false` и 100% при `true`
...@@ -328,6 +328,17 @@ fn proc_get_vshard_config(tier_name: Option<String>) -> Result ...@@ -328,6 +328,17 @@ fn proc_get_vshard_config(tier_name: Option<String>) -> Result
Возвращаемое значение: MP_MAP `VshardConfig` Возвращаемое значение: MP_MAP `VshardConfig`
<!--
- `VshardConfig`: (MP_MAP)
- `replicaset_uuid`: (MP_MAP)
- `replicas`: (MP_MAP)
- `instance_uuid`: (MP_MAP)
- `master`: (MP_BOOL)
- `uri`: (MP_STR)
- `name`: (MP_STR)
- `weight`: (MP_FLOAT)
-->
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
### .proc_instance_info {: #proc_instance_info } ### .proc_instance_info {: #proc_instance_info }
...@@ -475,9 +486,10 @@ raft-журнала и обнаруживает, что его журнал бы ...@@ -475,9 +486,10 @@ raft-журнала и обнаруживает, что его журнал бы
Последовательность таблиц в снапшоте детерминирована и совпадает между Последовательность таблиц в снапшоте детерминирована и совпадает между
разными версиями снапшотов. разными версиями снапшотов.
Следующий отрезок снапшота определяется параметрами: идентификатором последней таблицы, Следующий отрезок снапшота определяется параметрами: идентификатором
кортежи которой были получены в предыдущем отрезке, и количеством кортежей этой последней таблицы, кортежи которой были получены в предыдущем отрезке, и
таблицы, полученных за все предыдущие отрезки снапшота. количеством кортежей этой таблицы, полученных за все предыдущие отрезки
снапшота.
Параметры: Параметры:
...@@ -642,7 +654,7 @@ fn proc_sharding(raft_term, raft_index, timeout) ...@@ -642,7 +654,7 @@ fn proc_sharding(raft_term, raft_index, timeout)
между [репликасетами](../overview/glossary.md#replicaset). между [репликасетами](../overview/glossary.md#replicaset).
Этy хранимую процедуру вызывает только [governor](../overview/glossary.md#governor) Этy хранимую процедуру вызывает только [governor](../overview/glossary.md#governor)
в рамках алгоритма автоматической смены топологии кластера в рамках алгоритма автоматической смены топологии кластера.
См. также: См. также:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment