diff options
author | bazeltsev <bazeltsev@yandex-team.ru> | 2022-03-18 03:45:36 +0300 |
---|---|---|
committer | bazeltsev <bazeltsev@yandex-team.ru> | 2022-03-18 03:45:36 +0300 |
commit | e1d4810c0c73041a0f68b0f4d5047701975c3efe (patch) | |
tree | e3ed89e93547b2c651c332480a6422e60e2aedb3 | |
parent | 972191bd72f3e29e1070f02cc43917a1fc8a81ee (diff) | |
download | ydb-e1d4810c0c73041a0f68b0f4d5047701975c3efe.tar.gz |
Исправить ошибки в документации YDB 20220317
copy to kikimr
updated
ref:d7f2ff4f1d4bdd86266a641c54a205fa99d1b2b6
22 files changed, 48 insertions, 44 deletions
diff --git a/ydb/docs/ru/core/best_practices/_includes/timeouts.md b/ydb/docs/ru/core/best_practices/_includes/timeouts.md index 34fb5cfa95..52e20c75ee 100644 --- a/ydb/docs/ru/core/best_practices/_includes/timeouts.md +++ b/ydb/docs/ru/core/best_practices/_includes/timeouts.md @@ -6,9 +6,11 @@ description: 'Значение operation_timeout определяет время В разделе приведено описание доступных таймаутов и представлены примеры использования на различных языках программирования. ## Предпосылки к использованию таймаутов -Механизм тайматов в ydb призван решить следующие проблемы -1) Не дать запросу выполнятся так долго, что результат запроса становится не интересен для дальнейшего использования. -2) Обнаружение проблем сетевой связаности + +Механизм таймаутов в {{ ydb-short-name }} призван решить следующие проблемы: + +* Не дать запросу выполнятся так долго, что результат запроса становится не интересен для дальнейшего использования. +* Обнаружить проблем сетевой связанности. Оба этих случая важны для обеспечения отказоустойчивости системы в целом. Рассмотрим таймауты подробнее. diff --git a/ydb/docs/ru/core/concepts/_includes/connect.md b/ydb/docs/ru/core/concepts/_includes/connect.md index 35e3d09911..11b7f2ab6d 100644 --- a/ydb/docs/ru/core/concepts/_includes/connect.md +++ b/ydb/docs/ru/core/concepts/_includes/connect.md @@ -87,8 +87,8 @@ В специализированных статьях описано, как определять параметры соединения на клиенте: -* [Соединение с БД и аутентификация в {{ ydb-short-name }} CLI](../../reference/ydb-cli/connect.md) -* [Аутентификация в {{ ydb-short-name }} SDK](../../reference/ydb-sdk/auth.md) +* [Соединение с БД и аутентификация в {{ ydb-short-name }} CLI](../../reference/ydb-cli/connect.md). +* [Аутентификация в {{ ydb-short-name }} SDK](../../reference/ydb-sdk/auth.md). ## Дополнительная информация {#addition} diff --git a/ydb/docs/ru/core/concepts/cluster/_includes/common_scheme_ydb/tablets.md b/ydb/docs/ru/core/concepts/cluster/_includes/common_scheme_ydb/tablets.md index ae42e4f79f..275def47c7 100644 --- a/ydb/docs/ru/core/concepts/cluster/_includes/common_scheme_ydb/tablets.md +++ b/ydb/docs/ru/core/concepts/cluster/_includes/common_scheme_ydb/tablets.md @@ -1,4 +1,3 @@ - ## Таблетки {#tablets} На каждом узле выполняются специальные микросервисы, которые называются *таблетками*. Каждая таблетка имеет определенный тип и идентификатор и является singleton'ом, что означает, что в каждый момент времени во всем кластере может работать только одна таблетка с конкретным идентификатором. Таблетка может запускаться на любом из подходящих для нее узлов. Важной характеристикой таблетки является ее поколение — *Generation* — которое увеличивается при каждом следующем запуске. Стоит отметить, что в силу распределенности системы и наличии различного рода проблем, например, сетевого партиционирования, может сложиться ситуация, когда одна и та же таблетка будет фактически выполняться на двух разных узлах одновременно. Но BlobStorage гарантирует, что только одна из них сможет успешно завершить операции, изменяющие ее состояние, и при этом поколение, в котором выполнена каждая успешная операция, не будет убывать со временем. diff --git a/ydb/docs/ru/core/faq/_includes/sdk.md b/ydb/docs/ru/core/faq/_includes/sdk.md index 6c446cca13..bd5d6f1c62 100644 --- a/ydb/docs/ru/core/faq/_includes/sdk.md +++ b/ydb/docs/ru/core/faq/_includes/sdk.md @@ -16,7 +16,7 @@ A: Сессия в SDK однопоточная. Если нужно парал #### Что делать, если я получаю ошибку «Active sessions limit exceeded», хотя текущее количество активных сессий не превышает лимит? {#active-sessions-does-not-exceed-the-limit} -Лимит действует на количество активных сессий. Активная сессия — сессия, переданная клиенту для использования в его коде. Сессия возвращается в пулл в деструкторе. При этом, сама сессия является копируемым объектом. Возможно, вы сохранили в коде копию сессии. +Лимит действует на количество активных сессий. Активная сессия — сессия, переданная клиенту для использования в его коде. Сессия возвращается в пул в деструкторе. При этом, сама сессия является копируемым объектом. Возможно, вы сохранили в коде копию сессии. #### Есть ли возможность делать запросы к разным БД из одного приложения? {#make-requests-to-different-databases-from-the-same-application} diff --git a/ydb/docs/ru/core/getting_started/_includes/cli/ls_example_generic.md b/ydb/docs/ru/core/getting_started/_includes/cli/ls_example_generic.md index 26e6e6b7bc..ce22408a09 100644 --- a/ydb/docs/ru/core/getting_started/_includes/cli/ls_example_generic.md +++ b/ydb/docs/ru/core/getting_started/_includes/cli/ls_example_generic.md @@ -7,12 +7,12 @@ то команда будет выглядеть следующим образом: -``` bash +```bash {{ ydb-cli }} -e grpc://ydb.example.com:2136 -d /john/db1 scheme ls ``` Результат выполнения на только что созданной пустой базе данных: -``` text +```text .sys_health .sys ``` diff --git a/ydb/docs/ru/core/getting_started/_includes/cli/ls_example_local.md b/ydb/docs/ru/core/getting_started/_includes/cli/ls_example_local.md index 64ec61d279..292109c446 100644 --- a/ydb/docs/ru/core/getting_started/_includes/cli/ls_example_local.md +++ b/ydb/docs/ru/core/getting_started/_includes/cli/ls_example_local.md @@ -2,6 +2,6 @@ Если вы развернули локальную YDB по сценарию самостоятельного развертывания [в Docker](../../self_hosted/ydb_docker.md) с предложенной конфигурацией, то соединение с ней можно проверить командой: -``` bash +```bash {{ ydb-cli }} -e grpc://localhost:2136 -d /local scheme ls ``` diff --git a/ydb/docs/ru/core/getting_started/_includes/useful_links.md b/ydb/docs/ru/core/getting_started/_includes/useful_links.md index c54b805c05..44d291a9d8 100644 --- a/ydb/docs/ru/core/getting_started/_includes/useful_links.md +++ b/ydb/docs/ru/core/getting_started/_includes/useful_links.md @@ -6,6 +6,6 @@ {% endif %} -* [Консоль управления в Yandex.Cloud](https://console.cloud.yandex.ru) +* [Консоль управления в {{ yandex-cloud }}](https://console.cloud.yandex.ru) * [GitHub account ydb-platform](https://github.com/ydb-platform) diff --git a/ydb/docs/ru/core/getting_started/_includes/yql.md b/ydb/docs/ru/core/getting_started/_includes/yql.md index c6e9d223d3..e65f320f1d 100644 --- a/ydb/docs/ru/core/getting_started/_includes/yql.md +++ b/ydb/docs/ru/core/getting_started/_includes/yql.md @@ -32,7 +32,7 @@ YQL - язык запросов к базе данных {{ ydb-short-name }}, Текст приведенных ниже скриптов нужно сохранить в файл. Назовите его `script.yql`, чтобы команды в примерах можно было выполнить простым копированием через буфер обмена. Далее выполните команду `{{ ydb-cli }} yql` с указанием использования профиля `db1` и чтения скрипта из файла `script.yql`: -``` bash +```bash {{ ydb-cli }} --profile db1 yql -f script.yql ``` @@ -90,7 +90,7 @@ CREATE TABLE episodes ( Для получения перечня существующих таблиц в БД через {{ ydb-short-name }} CLI убедитесь, что выполнены предварительные требования пункта [Исполнение в {{ ydb-short-name }} CLI](#cli) данной статьи, и выполните [команду `scheme ls`](../cli.md#ping): -``` bash +```bash {{ ydb-cli }} --profile db1 scheme ls ``` @@ -200,7 +200,7 @@ WHERE sa.series_id = $seriesId AND sa.season_id = $seasonId; Для выполнения параметризованной выборки убедитесь, что выполнены предварительные требования пункта [Исполнение в {{ ydb-short-name }} CLI](#cli) данной статьи, и выполните следующую команду: -``` bash +```bash {{ ydb-cli }} --profile db1 yql -f script.yql -p '$seriesId=1' -p '$seasonId=1' ``` diff --git a/ydb/docs/ru/core/maintenance/manual/change_actorsystem_configs.md b/ydb/docs/ru/core/maintenance/manual/change_actorsystem_configs.md index 03dc2e8535..b3a325bf3e 100644 --- a/ydb/docs/ru/core/maintenance/manual/change_actorsystem_configs.md +++ b/ydb/docs/ru/core/maintenance/manual/change_actorsystem_configs.md @@ -2,7 +2,7 @@ # Изменение конфигурации актор-системы Актор-система основа YDB, каждый компонент системы представляется одним или несколькими акторами. -Каждый актор распределен в определенный ExecutorPool, соответствующий задачи актора. +Каждый актор распределен в определенный ExecutorPool, соответствующий задаче актора. Изменение конфигурации поможет более точно распределить количество зарезервированных ядер для каждого типа задач. ## Описание конфига актор-системы @@ -17,7 +17,7 @@ * IO - отвечает за выполнение всех задач с блокирующими операциями (как пример запись логов в файл); * IC - Interconnect, включает всю нагрузку связанную с коммуникацией между узлами. -Каждый пулл описывается полем Executor, как в примере ниже. +Каждый пул описывается полем Executor, как в примере ниже. ```proto Executor { @@ -31,11 +31,11 @@ Executor { Описание основных полей: * **Type** - на данный момент может иметь два типа: **BASIC** и **IO**. Все пулы, кроме **IO**, имеют тип **BASIC**; -* **Threads** - количество потоков(количество параллельно работающих акторов) в данном пуле; -* **SpinThreshold** - количество тактов процессора перед уходом в сон при отсутствии задач, которое будет поток выполняющий работу акторов(влияет на потребление cpu и latency запросов во время слабой нагрузки); -* **Name** - название пуля которые будет отображаться у узла в мониторинге. +* **Threads** - количество потоков (количество параллельно работающих акторов) в данном пуле; +* **SpinThreshold** - количество тактов процессора перед уходом в сон при отсутствии задач, которое будет исполнять поток, выполняющий работу акторов (влияет на потребление cpu и latency запросов во время слабой нагрузки); +* **Name** - название пула, которое будет отображаться у узла в мониторинге. -Сопоставление пуллов с типами задач происходит заданием порядкового номера пулла в специальные поля. Пуллы нумеруются с нуля, так же на один пулл может повесить несколько типов задач. +Сопоставление пулов с типами задач происходит заданием порядкового номера пула в специальные поля. Пулы нумеруются с нуля, также на один пул может повесить несколько типов задач. Список полей с их задачами: @@ -53,7 +53,7 @@ BatchExecutor: 2 IoExecutor: 3 ``` -IC пулл задается другим способом, через ServiceExecutor, как в примере ниже. +IC пул задается другим способом, через ServiceExecutor, как в примере ниже. ```proto ServiceExecutor { @@ -68,9 +68,9 @@ ServiceExecutor { * **SpinThreshold** - аналогично с параметром пула, количество тактов процессора перед уходом в сон при отсутствии сообщений; * **ProgressThreshold** - максимальный шаг смещения времени в микросекундах. -В случае если по неизвестным причинам поток шедулера залип, то он будет отправлять сообщения по отстающему времени смещая его каждый раз на **ProgressThreshold**. +В случае если по неизвестным причинам поток шедулера залип, то он будет отправлять сообщения по отстающему времени, смещая его каждый раз на **ProgressThreshold**. -Не рекомендуется менять конфиг шедулера. В конфигах пуллов рекомендуется менять только количество потоков. +Не рекомендуется менять конфиг шедулера. В конфигах пулов рекомендуется менять только количество потоков. Пример конфига актор-системы по умолчанию: @@ -124,7 +124,7 @@ ServiceExecutor { ## На динамических узлах -Динамические узлы берут конфигурацию из [CMS](cms.md)cms, чтобы изменить ее можно воспользоваться следующей командой. +Динамические узлы берут конфигурацию из [CMS](cms.md), чтобы изменить ее, можно воспользоваться следующей командой: ```proto ConfigureRequest { diff --git a/ydb/docs/ru/core/reference/ydb-cli/export_import/_includes/s3_conn.md b/ydb/docs/ru/core/reference/ydb-cli/export_import/_includes/s3_conn.md index 710436d21f..e7cf09bfbb 100644 --- a/ydb/docs/ru/core/reference/ydb-cli/export_import/_includes/s3_conn.md +++ b/ydb/docs/ru/core/reference/ydb-cli/export_import/_includes/s3_conn.md @@ -41,11 +41,11 @@ YDB CLI определяет значения этих параметров из ## Получение параметров соединения с S3 {#procure} -### Yandex.Cloud +### {{ yandex-cloud }} -Ниже описан сценарий получения ключей доступа к [Yandex.Cloud Object Storage](https://cloud.yandex.ru/docs/storage/) с применением Yandex.Cloud CLI. +Ниже описан сценарий получения ключей доступа к [{{ yandex-cloud }} Object Storage](https://cloud.yandex.ru/docs/storage/) с применением {{ yandex-cloud }} CLI. -1. [Установите и сконфигурируйте](https://cloud.yandex.ru/docs/cli/quickstart) Yandex.Cloud CLI. +1. [Установите и сконфигурируйте](https://cloud.yandex.ru/docs/cli/quickstart) {{ yandex-cloud }} CLI. 2. Получите ID вашего каталога в облаке следующей командой, его понадобится указывать в командах ниже: @@ -90,7 +90,7 @@ YDB CLI определяет значения этих параметров из , где `<folder-id>` - это идентификатор каталога в облаке, полученный на шаге 2. - Вы можете также ознакомиться с [полным перечнем](https://cloud.yandex.ru/docs/iam/concepts/access-control/roles#object-storage) ролей Yandex.Cloud. + Вы можете также ознакомиться с [полным перечнем](https://cloud.yandex.ru/docs/iam/concepts/access-control/roles#object-storage) ролей {{ yandex-cloud }}. 4. Получите [статические ключи доступа](https://cloud.yandex.ru/docs/iam/operations/sa/create-access-key), выполнив следующую команду: diff --git a/ydb/docs/ru/core/reference/ydb-cli/export_import/_includes/tools_restore.md b/ydb/docs/ru/core/reference/ydb-cli/export_import/_includes/tools_restore.md index 14e4cca89c..8ba84af0f5 100644 --- a/ydb/docs/ru/core/reference/ydb-cli/export_import/_includes/tools_restore.md +++ b/ydb/docs/ru/core/reference/ydb-cli/export_import/_includes/tools_restore.md @@ -38,11 +38,11 @@ {% note warning "Внимание" %} -Некоторые из перечисленных ниже параметров имеют действующие значения по-умолчанию. Это значит, что если даже ни один из них не задан в команде вызова `tools restore`, нагрузка все равно будет ограничена. +Некоторые из перечисленных ниже параметров имеют действующие значения по умолчанию . Это значит, что если даже ни один из них не задан в команде вызова `tools restore`, нагрузка все равно будет ограничена. {% endnote %} -`--bandwidth VAL`: Ограничение объема загрузки в секунду, по-умолчанию 0 (не установлено). `VAL` определяет объем, задается в виде числа с приставкой, например 2MiB. +`--bandwidth VAL`: Ограничение объема загрузки в секунду, по умолчанию 0 (не установлено). `VAL` определяет объем, задается в виде числа с приставкой, например 2MiB. `--rps VAL`: Ограничение количества запросов на загрузку пакетов данных в базу данных в секунду, по умолчанию 30. `--in-flight VAL`: Ограничения количество запросов, одновременно находящихся в состоянии исполнения, по умолчанию 10. `--upload-batch-rows VAL`: Ограничение количества записей в пакете загружаемых данных, по умолчанию 0 (не ограничено). `VAL` определяет количество записей, задается в виде числа с необзятельной десятичной приставкой, например 1K. diff --git a/ydb/docs/ru/core/reference/ydb-sdk/_includes/auth.md b/ydb/docs/ru/core/reference/ydb-sdk/_includes/auth.md index 39ac04c3c8..200dc1e9d0 100644 --- a/ydb/docs/ru/core/reference/ydb-sdk/_includes/auth.md +++ b/ydb/docs/ru/core/reference/ydb-sdk/_includes/auth.md @@ -69,7 +69,7 @@ 4. Иначе, если задано значение переменной окружения `YDB_ACCESS_TOKEN_CREDENTIALS`, то используется режим аутентификации **Access token**, в который передается значение данной переменной 5. Иначе используется режим аутентификации **Metadata** -Наличие последним пунктом алгоритма выбора режима **Metadata** позволяет развернуть рабочее приложение на виртуальных машинах и в Cloud Functions Yandex.Cloud без задания каких-либо переменных окружения. +Наличие последним пунктом алгоритма выбора режима **Metadata** позволяет развернуть рабочее приложение на виртуальных машинах и в Cloud Functions {{ yandex-cloud }} без задания каких-либо переменных окружения. ## Особенности Python SDK diff --git a/ydb/docs/ru/core/reference/ydb-sdk/example/go/_includes/run_docker.md b/ydb/docs/ru/core/reference/ydb-sdk/example/go/_includes/run_docker.md index 98d627c3af..e755187aab 100644 --- a/ydb/docs/ru/core/reference/ydb-sdk/example/go/_includes/run_docker.md +++ b/ydb/docs/ru/core/reference/ydb-sdk/example/go/_includes/run_docker.md @@ -1,4 +1,4 @@ -Для соединения с развернутой локальной базой данных YDB по сценарию [Docker](../../../../../getting_started/self_hosted/ydb_docker.md) в конфигурации по-умолчанию выполните следующую команду: +Для соединения с развернутой локальной базой данных YDB по сценарию [Docker](../../../../../getting_started/self_hosted/ydb_docker.md) в конфигурации по умолчанию выполните следующую команду: ``` bash ( export YDB_ANONYMOUS_CREDENTIALS=1 && cd ydb-go-examples && \ diff --git a/ydb/docs/ru/core/reference/ydb-sdk/example/python/_includes/run_docker.md b/ydb/docs/ru/core/reference/ydb-sdk/example/python/_includes/run_docker.md index 54026e8ff9..d73c1cd448 100644 --- a/ydb/docs/ru/core/reference/ydb-sdk/example/python/_includes/run_docker.md +++ b/ydb/docs/ru/core/reference/ydb-sdk/example/python/_includes/run_docker.md @@ -1,4 +1,4 @@ -Для соединения с развернутой локальной базой данных YDB по сценарию [Docker](../../../../../getting_started/self_hosted/ydb_docker.md) в конфигурации по-умолчанию выполните следующую команду: +Для соединения с развернутой локальной базой данных YDB по сценарию [Docker](../../../../../getting_started/self_hosted/ydb_docker.md) в конфигурации по умолчанию выполните следующую команду: ``` bash YDB_ANONYMOUS_CREDENTIALS=1 \ diff --git a/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth/_includes/access_token.md b/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth/_includes/access_token.md index a63589e9b9..89ddec8b24 100644 --- a/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth/_includes/access_token.md +++ b/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth/_includes/access_token.md @@ -2,7 +2,7 @@ {% include [work in progress message](../../_includes/addition.md) %} -Ниже приведены примеры кода аутентификации при помощи токена в разных {{ ydb-short-name }} SDK +Ниже приведены примеры кода аутентификации при помощи токена в разных {{ ydb-short-name }} SDK. {% list tabs %} diff --git a/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth/_includes/env.md b/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth/_includes/env.md index 42b4a96650..b1772d1300 100644 --- a/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth/_includes/env.md +++ b/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth/_includes/env.md @@ -11,7 +11,7 @@ * `YDB_METADATA_CREDENTIALS="1"` — использовать сервис метаданных внутри Яндекс Облака (Яндекс функция или виртуальная машина) * `YDB_ACCESS_TOKEN_CREDENTIALS=<access_token>` — использовать аутентификацию с токеном -Ниже приведены примеры кода аутентификации при помощи переменных окружения в разных {{ ydb-short-name }} SDK +Ниже приведены примеры кода аутентификации при помощи переменных окружения в разных {{ ydb-short-name }} SDK. {% list tabs %} diff --git a/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth/_includes/index.md b/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth/_includes/index.md index 632f727147..ebd3eb83f5 100644 --- a/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth/_includes/index.md +++ b/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth/_includes/index.md @@ -2,6 +2,6 @@ {% include [work in progress message](../../_includes/addition.md) %} -{{ ydb-short-name }} поддерживает несколько способов аутентификации подключения к серверной стороне. Каждый из них, как правило, специфичен для конкретной пары окружений: где находится клиентское приложение (в доверенной зоне {{ ydb-short-name }} или вне ее) и серверная часть {{ ydb-short-name }} (докер-контейнер, yandex.Cloud, data cloud, установка на отдельном кластере) +{{ ydb-short-name }} поддерживает несколько способов аутентификации подключения к серверной стороне. Каждый из них, как правило, специфичен для конкретной пары окружений: где находится клиентское приложение (в доверенной зоне {{ ydb-short-name }} или вне ее) и серверная часть {{ ydb-short-name }} (докер-контейнер, {{ yandex-cloud }}, data cloud, установка на отдельном кластере) В данном разделе содержатся рецепты кода с настройкой аутентификации в разных {{ ydb-short-name }} SDK. Общее описание принципов аутентификации в SDK можно прочитать в статье [Аутентификация в SDK](../../../auth.md). diff --git a/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth/_includes/metadata.md b/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth/_includes/metadata.md index 9ae4b2e2f9..f0502f89a8 100644 --- a/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth/_includes/metadata.md +++ b/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth/_includes/metadata.md @@ -2,7 +2,7 @@ {% include [work in progress message](../../_includes/addition.md) %} -Ниже приведены примеры кода аутентификации при помощи переменных окружения в разных {{ ydb-short-name }} SDK +Ниже приведены примеры кода аутентификации при помощи переменных окружения в разных {{ ydb-short-name }} SDK. {% list tabs %} diff --git a/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth/_includes/service_account.md b/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth/_includes/service_account.md index d0c465cff2..ab98a99d6d 100644 --- a/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth/_includes/service_account.md +++ b/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth/_includes/service_account.md @@ -2,7 +2,7 @@ {% include [work in progress message](../../_includes/addition.md) %} -Ниже приведены примеры кода аутентификации при помощи файла сервисного аккаунта в разных {{ ydb-short-name }} SDK +Ниже приведены примеры кода аутентификации при помощи файла сервисного аккаунта в разных {{ ydb-short-name }} SDK. {% list tabs %} diff --git a/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth/_includes/static.md b/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth/_includes/static.md index 0da366a49a..4aa76e771d 100644 --- a/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth/_includes/static.md +++ b/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth/_includes/static.md @@ -2,7 +2,7 @@ {% include [work in progress message](../../_includes/addition.md) %} -Ниже приведены примеры кода аутентификации при помощи логина и пароля в разных {{ ydb-short-name }} SDK +Ниже приведены примеры кода аутентификации при помощи логина и пароля в разных {{ ydb-short-name }} SDK. {% list tabs %} diff --git a/ydb/docs/ru/core/reference/ydb-sdk/recipes/retry/_includes/go.md b/ydb/docs/ru/core/reference/ydb-sdk/recipes/retry/_includes/go.md index 9c2fbefdb8..5cbfdb42a1 100644 --- a/ydb/docs/ru/core/reference/ydb-sdk/recipes/retry/_includes/go.md +++ b/ydb/docs/ru/core/reference/ydb-sdk/recipes/retry/_includes/go.md @@ -1,15 +1,17 @@ В {{ ydb-short-name }} Go SDK корректная обработка ошибок закреплена в нескольких программных интерфейсах: -* Основная логика обработки ошибок реализуется функцией-помощником `retry.Retry` + +* Основная логика обработки ошибок реализуется функцией-помощником `retry.Retry`. Подробности выполнения повторных запросов максимально скрыты. Пользователь может влиять на логику работы функции `retry.Retry` двумя способами: - - через контекст (можно устанавливать deadline и cancel) - - через флаг идемпотентности операции `retry.WithIdempotent()`. По умолчанию операция считается неидемпотентной. + * через контекст (можно устанавливать deadline и cancel) + * через флаг идемпотентности операции `retry.WithIdempotent()`. По умолчанию операция считается неидемпотентной. Пользователь передает свою функцию в `retry.Retry`, которая по своей сигнатуре должна возвращать ошибку. В случае, если из пользовательской функции вернулся `nil`, то повторные запросы прекращаются. В случае, если из пользовательской функции вернулась ошибка, {{ ydb-short-name }} Go SDK пытается идентифицировать эту ошибку и в зависимости от нее выполняет повторные попытки. {% cut "Пример кода, использующего функцию `retry.Retry`:" %} + ```go package main @@ -53,9 +55,10 @@ } } ``` + {% endcut %} + * Сервис для работы с табличными запросами `db.Table()` сразу предоставляет программный интерфейс `table.Client`, который использует пакет `retry`, а также следит за временем жизни сессий {{ ydb-short-name }}. Пользователю доступны две публичных функции: `db.Table().Do(ctx, op)` (`op` предоставляет сессию) и `db.Table().DoTx(ctx, op)` (`op` предоставляет транзакцию). Как и в предыдущем случае пользователь может влиять на логику выполнения повторных запросов через контекст и признак идемпотентности, а {{ ydb-short-name }} Go SDK интерпретирует возвращаемые из `op` ошибки. * Запросы к остальным сервисам {{ ydb-short-name }} (`db.Scripting()`, `db.Scheme()`, `db.Coordination()`, `db.Ratelimiter()`, `db.Discovery()`) также используют внутри себя функцию `retry.Retry` для выполнения повторных запросов. - diff --git a/ydb/docs/ru/core/yql/reference/yql-docs-core-2/builtins/_includes/window/aggregate.md b/ydb/docs/ru/core/yql/reference/yql-docs-core-2/builtins/_includes/window/aggregate.md index e101518a20..083cdd90c3 100644 --- a/ydb/docs/ru/core/yql/reference/yql-docs-core-2/builtins/_includes/window/aggregate.md +++ b/ydb/docs/ru/core/yql/reference/yql-docs-core-2/builtins/_includes/window/aggregate.md @@ -3,7 +3,7 @@ Все [агрегатные функции](../../aggregation.md) также могут использоваться в роли оконных. В этом случае на каждой строке оказывается результат агрегации, полученный на множестве строк из [рамки окна](../../../syntax/window.md#frame). -**Примеры:* +**Примеры:** ``` yql SELECT SUM(int_column) OVER w1 AS running_total, |