aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authoralexv-smirnov <alexv-smirnov@yandex-team.ru>2022-02-23 06:18:28 +0300
committeralexv-smirnov <alexv-smirnov@yandex-team.ru>2022-02-23 06:18:28 +0300
commitf519663e7907e75fa0727864bc324443c133f317 (patch)
tree980df128e26a014b40a052c8a14e34bbbc81f293
parent16f3c3ccfbbde4e6b500145f8df51870559dd717 (diff)
downloadydb-f519663e7907e75fa0727864bc324443c133f317.tar.gz
ydb docs sdk go/python example launch sequence, ydb_docker scenario refactored
ref:bf922a80d13df6949d1429a3108bbbde9f5a21f6
-rw-r--r--ydb/docs/ru/core/concepts/_includes/connect.md2
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/auth.md8
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/cli.md38
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/cli/ls_example_generic.md9
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/cli/ls_example_local.md7
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/create_db.md8
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/index/yql.md2
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/ydb_docker/01_intro.md22
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/ydb_docker/02_install.md2
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/ydb_docker/03_start.md65
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/ydb_docker/04_request.md44
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/ydb_docker/05_stop.md2
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/yql.md8
-rw-r--r--ydb/docs/ru/core/getting_started/toc_i.yaml4
-rw-r--r--ydb/docs/ru/core/reference/ydb-cli/_includes/commands.md1
-rw-r--r--ydb/docs/ru/core/reference/ydb-sdk/example/_includes/index.md14
-rw-r--r--ydb/docs/ru/core/reference/ydb-sdk/example/_includes/steps/01_init.md2
-rw-r--r--ydb/docs/ru/core/reference/ydb-sdk/example/go/index.md2
18 files changed, 106 insertions, 134 deletions
diff --git a/ydb/docs/ru/core/concepts/_includes/connect.md b/ydb/docs/ru/core/concepts/_includes/connect.md
index ced88597bc..b9cbec42aa 100644
--- a/ydb/docs/ru/core/concepts/_includes/connect.md
+++ b/ydb/docs/ru/core/concepts/_includes/connect.md
@@ -50,7 +50,7 @@
- **Anonymous** обычно применяется на самостоятельно разворачиваемых локальных кластерах YDB, недоступных по сети
- **Access Token** применяется при отсутствии поддержки других режимов на стороне сервера, или в настроечных/отладочных целях. Он не требует взаимодействий клиента с IAM. Однако, если IAM поддерживает API для ротации токенов, то обычно выдаваемые таким IAM фиксированные токены имеют короткий срок жизни, что вынуждает регулярно обновлять их в IAM вручную заново.
- **Refresh Token** может применяться при выполнении разовых ручных операций под персональной учетной записью, например, связанных с обслуживанием данных в БД, выполнением ad-hoc операций в CLI, или запусками приложений с рабочей станции. Такой токен можно получить вручную в IAM один раз на долгий срок, и сохранить в переменной окружения на личной рабочей станции для автоматического применения при запуске CLI без дополнительных параметров аутентификации.
-- **Service Account Key** применяется в первую очередь для приложений, рассчитанных на эксплуатацию в окружениях, где поддерживается режим **Metadata**, при их тестировании вне таких окружений (например, на рабочей станции). Также он может применяться для приложений вне таких окружений, работая как аналог **Refresh Token** для сервисных учетных записей.
+- **Service Account Key** применяется в первую очередь для приложений, рассчитанных на эксплуатацию в окружениях, где поддерживается режим **Metadata**, при их тестировании вне таких окружений (например, на рабочей станции). Также он может применяться для приложений вне таких окружений, работая как аналог **Refresh Token** для сервисных учетных записей. В отличие от персональной учетной записи, объекты доступа и роли сервисной учетной записи могуть быть ограничены.
- **Metadata** применяется при разворачивании приложений в облаках. В настоящее время этот режим поддерживается на виртуальных машинах и в Cloud Functions Yandex.Cloud.
Токен для указания в параметрах может быть получен в системе IAM, с которой связана конкретная установка YDB. В частности, для сервиса YDB в Yandex.Cloud применяется Yandex.Passport OAuth и сервисные аккаунты Yandex.Cloud. При использовании YDB в корпоративных контекстах могут применяться стандартные для данной организации системы централизованной аутентификации.
diff --git a/ydb/docs/ru/core/getting_started/_includes/auth.md b/ydb/docs/ru/core/getting_started/_includes/auth.md
index 1fa3f327f3..b475cac608 100644
--- a/ydb/docs/ru/core/getting_started/_includes/auth.md
+++ b/ydb/docs/ru/core/getting_started/_includes/auth.md
@@ -1,7 +1,9 @@
# Аутентификация - Начало работы
-Для соединения с развернутой локально базой данных OpenSource YDB вам не нужно указывать никаких параметров, связанных с аутентификацией.
-
-Быстрые рецепты настройки аутентификации при соединении с БД в облачных сервисах или в корпоративных контекстах описаны в их документации в разделе YDB / Начало работы / Аутентификация.
+Разворачиваемая сценариями самостоятельного развертывания локальная база данных YDB не требует аутентификации, то есть работает в [анонимном режиме](../../concepts/connect.md#auth-modes).
Полная информация о всех доступных способах аутентификации приведена в статье [Соединение с базой данных](../../concepts/connect.md) в разделе "Концепции".
+
+## Продолжение знакомства с YDB {#next}
+
+Перейдите к статье [YDB CLI - Начало работы](../cli.md) для продолжения знакомства с YDB.
diff --git a/ydb/docs/ru/core/getting_started/_includes/cli.md b/ydb/docs/ru/core/getting_started/_includes/cli.md
index ce2e734bdf..f1560e0fd6 100644
--- a/ydb/docs/ru/core/getting_started/_includes/cli.md
+++ b/ydb/docs/ru/core/getting_started/_includes/cli.md
@@ -7,16 +7,21 @@
- [Эндпоинт](../../concepts/connect.md#endpoint)
- [Имя базы данных](../../concepts/connect.md#database)
-Также вам может потребоваться токен или логин/пароль, если база данных требует [аутентификации](../auth.md). Если для аутентификации применяется токен, то для успешного исполнения сценария ниже вам нужно выбрать вариант его сохранения в переменной окружения.
+Также вам может потребоваться токен или логин/пароль, если база данных требует [аутентификации](../auth.md). Для успешного исполнения сценария ниже вам нужно выбрать вариант их сохранения в переменной окружения.
## Установка CLI {#install}
Установите YDB CLI как описано в статье [Установка YDB CLI](../../reference/ydb-cli/install.md).
-Проверьте успешность установки YDB CLI запуском с параметром `--help`. В ответ должно быть выведено приветственное сообщение, краткое описание синтаксиса, и перечень доступных команд:
+Проверьте успешность установки YDB CLI запуском с параметром `--help`:
``` bash
-$ {{ ydb-cli }} --help
+{{ ydb-cli }} --help
+```
+
+В ответ должно быть выведено приветственное сообщение, краткое описание синтаксиса, и перечень доступных команд:
+
+``` text
YDB client
Usage: ydb [options...] <subcommand>
@@ -39,13 +44,13 @@ ydb
{{ ydb-cli }} -e <endpoint> -d <database> scheme ls
```
-При успешном выполнении команды в ответ будет выведен перечень объектов в базе данных. Если вы еще не создавали ничего в БД, то вывод будет содержать только системный каталог `.sys`, в котором находятся [диагностические представления YDB](../../troubleshooting/system_views.md).
+При успешном выполнении команды в ответ будет выведен перечень объектов в базе данных. Если вы еще не создавали ничего в БД, то вывод будет содержать только системные каталоги `.sys` и `.sys_health`, в которых находятся [диагностические представления YDB](../../troubleshooting/system_views.md).
{% include [cli/ls_examples.md](cli/ls_examples.md) %}
## Создание профиля соединения {#profile}
-Параметры соединения с базой данных могут быть довольно длинными, особенно при использовании явного указания [параметров аутентификации в командной строке](../../reference/ydb-cli/connect.md#command-line-pars). Чтобы не писать их каждый раз при вызове YDB CLI, воспользуйтесь [профилем](../../reference/ydb-cli/profile/index.md).
+Чтобы не писать параметры соединения каждый раз при вызове YDB CLI, воспользуйтесь [профилем](../../reference/ydb-cli/profile/index.md). Создание предложенного ниже профиля позволит вам также копировать дальнейшие команды через буфер обмена без их редактирования, вне зависимости от того на какой базе данных вы проходите сценарий "Начала работы".
[Создайте профиль](../../reference/ydb-cli/profile/create.md) `db1` следующей командой:
@@ -55,12 +60,9 @@ ydb
В интерактивном режиме будут запрошены параметры соединения, которые нужно связать с данным профилем. Используйте для них проверенные на [предыдущем шаге](#ping) значения.
-Имя профиля `db1` будет использоваться в следующих шагах, чтобы вы могли просто копировать примеры через буфер обмена.
-
Проверьте работоспособность профиля командой `scheme ls`:
``` bash
-$ {{ ydb-cli }} --profile db1 scheme ls
-.sys
+{{ ydb-cli }} --profile db1 scheme ls
```
## Исполнение YQL скрипта {#yql}
@@ -68,32 +70,34 @@ $ {{ ydb-cli }} --profile db1 scheme ls
Команда YDB CLI `scripting yql` позволяет выполнить любую команду (как DDL так и DML) на [языке YQL](../../yql/reference/index.md) - диалекте SQL, поддерживаемом YDB:
``` bash
-{{ ydb-cli }} --profile <profile_name> scripting yql -s <yql_request>
+{{ ydb-cli }} --profile <profile_name> yql -s <yql_request>
```
Например:
- Создание таблицы
``` bash
- {{ ydb-cli }} --profile db1 scripting yql -s "create table t1( id uint64, primary key(id))"
+ {{ ydb-cli }} --profile db1 yql -s "create table t1( id uint64, primary key(id))"
```
- Добавление записи
``` bash
- {{ ydb-cli }} --profile db1 scripting yql -s "insert into t1(id) values (1)"
+ {{ ydb-cli }} --profile db1 yql -s "insert into t1(id) values (1)"
```
- Выборка данных
``` bash
- {{ ydb-cli }} --profile db1 scripting yql -s "select * from t1"
+ {{ ydb-cli }} --profile db1 yql -s "select * from t1"
```
Если вы получаете ошибку `Profile db1 does not exist` - значит вы не создали его на [предыдущем шаге](#profile).
-Для знакомства с синтаксисом и основными командами YQL перейдите к статье [YQL - Начало работы](../yql.md).
-
## Специализированные команды CLI {#ydb-api}
-Исполнение команд через `scripting yql` является хорошим простым способом начать работу. Однако, YQL-интерфейс поддерживает неполный набор возможных функций, доступных на YDB API, а также работает не самым эффективным образом из-за своей универсальности.
+Исполнение команд через `ydb yql` является хорошим простым способом начать работу. Однако, YQL-интерфейс поддерживает неполный набор возможных функций, доступных на YDB API, а также работает не самым эффективным образом из-за своей универсальности.
+
+YDB CLI поддерживает отдельные команды с полным набором опций для всех существующих YDB API. Описание полного перечня команд находится в [справочнике по YDB CLI](../../reference/ydb-cli/index.md).
+
+## Продолжение знакомства с YDB {#next}
-YDB CLI поддерживает отдельные команды с полным набором опций для всех существующих YDB API. Описание полного перечня команд находится в [справочнике по YDB CLI](../../reference/ydb-cli/index.md). \ No newline at end of file
+Перейдите к статье [YQL - Начало работы](../yql.md) для продолжения знакомства с YDB. \ No newline at end of file
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 14cb78cf81..ca0d917c58 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
@@ -6,6 +6,11 @@
То команда и результат выполнения будут выглядеть следующим образом:
``` bash
-$ {{ ydb-cli }} -e grpc://ydb.example.com:2136 -d /john/db1 scheme ls
-.sys
+{{ ydb-cli }} -e grpc://ydb.example.com:2136 -d /john/db1 scheme ls
+```
+
+Результат выполнения на только что созданной пустой базе данных:
+
+``` 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 d94afd2456..de1eb89c88 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
@@ -1,8 +1,9 @@
### Соединение с локальной БД
-Если вы развернули локальную YDB по одному из описанных сценариев [Самостоятельного развертывания](../../create_db.md#self-hosted) с предложенной конфигурацией, то соединение с ней можно проверить командой:
+Если вы развернули локальную YDB по сценарию самостоятельного развертывания [в Docker](../../ydb_docker.md) с предложенной конфигурацией, то соединение с ней можно проверить командой:
``` bash
-$ {{ ydb-cli }} -e grpc://localhost:2136 -d /local scheme ls
-.sys
+{{ ydb-cli }} -e grpc://localhost:2136 -d /local scheme ls
```
+
+
diff --git a/ydb/docs/ru/core/getting_started/_includes/create_db.md b/ydb/docs/ru/core/getting_started/_includes/create_db.md
index f33d8c2922..10032b2762 100644
--- a/ydb/docs/ru/core/getting_started/_includes/create_db.md
+++ b/ydb/docs/ru/core/getting_started/_includes/create_db.md
@@ -10,10 +10,8 @@
* [В Kubernetes](../../deploy/orchestrated/concepts.md).
* [Локально из скачанного исполняемого файла](../ydb_local.md).
-По умолчанию в результате выполнения этих сценариев вы получите базу данных со следующими параметрами соединения:
+Подробная информация о базах данных находится в статье [Термины и определения - База данных](../../concepts/databases.md#database) в разделе Концепции.
-* Эндпоинт: `grpc://localhost:2136`.
-* Имя базы данных: `/local`.
-* Аутентификация: не требуется.
+## Продолжение знакомства с YDB {#next}
-Подробная информация о базах данных находится в статье [Термины и определения - База данных](../../concepts/databases.md#database) в разделе Концепции.
+После создания базы данных перейдите к статье [Аутентификация - Начало работы](../auth.md) для продолжения знакомства с YDB. \ No newline at end of file
diff --git a/ydb/docs/ru/core/getting_started/_includes/index/yql.md b/ydb/docs/ru/core/getting_started/_includes/index/yql.md
index b4066fac85..29882b4a0b 100644
--- a/ydb/docs/ru/core/getting_started/_includes/index/yql.md
+++ b/ydb/docs/ru/core/getting_started/_includes/index/yql.md
@@ -1 +1 @@
-* [YQL](../../yql.md) — познакомьтесь с {{ yql-short-name }} - основным языком запросов к {{ ydb-short-name }}, диалектом SQL.
+* [YQL](../../yql.md) — познакомьтесь с YQL - основным языком запросов к {{ ydb-short-name }}, диалектом SQL.
diff --git a/ydb/docs/ru/core/getting_started/_includes/ydb_docker/01_intro.md b/ydb/docs/ru/core/getting_started/_includes/ydb_docker/01_intro.md
index 5c48a1144a..e4abfe80f1 100644
--- a/ydb/docs/ru/core/getting_started/_includes/ydb_docker/01_intro.md
+++ b/ydb/docs/ru/core/getting_started/_includes/ydb_docker/01_intro.md
@@ -1,19 +1,21 @@
# Использование Docker-контейнера YDB
-Для отладки или тестирования вы можете запустить {{ ydb-full-name }} в Docker-контейнере. Docker-контейнер содержит актуальную версию сборки {{ ydb-short-name }}, ревизия сборки может отличаться.
+Для отладки или тестирования вы можете запустить [Docker](https://docs.docker.com/get-docker/)-контейнер YDB.
-В режиме локального запуска для работы с базой данных предоставляется только {{ ydb-short-name }} API. Имя базы данных `/local`. Работа с базой выполняется с помощью консольного клиента {{ ydb-short-name }} ([YDB CLI](../../../reference/ydb-cli/index.md)), предустановленного внутри Docker-образа.
+В результате выполнения описанных ниже инструкций вы получите локальную базу данных YDB, к которой можно будет обратиться по следующим реквизитам:
-В контейнере доступны следующие службы:
+{% list tabs %}
-* `GRPC_PORT` - порт для взаимодействия с {{ ydb-short-name }} API по gRPC без TLS. По умолчанию, порт равен 2136.
-* `GRPC_TLS_PORT` - порт для взаимодействия с {{ ydb-short-name }} API по gRPC c поддержкой TLS. Сертификаты генерируются автоматически. Для использования сертификатов необходимо смонтировать на хост-системе директорию `/ydb_cert` Docker-контейнера. По умолчанию, порт равен 2135.
-* `MON_PORT` - порт сo встроенными средствами мониторинга и интроспекции. По умолчанию, порт равен 8765.
+- gRPC
-Для локального сохранения состояния базы данных на хост-системе монтируется директория `/ydb_data` Docker-контейнера.
+ - [Эндпоинт](../../../concepts/connect.md#endpoint): `grpc://localhost:2136`
+ - [Размещение базы данных](../../../concepts/connect.md#database): `/local`
+ - [Аутентификация](../../../concepts/connect.md#auth-modes): Анонимная (без аутентификации)
-{% note warning %}
+- gRPCs/TLS
-При работе локальной базы данных, в зависимости от задач, может использоваться значительная часть вычислительных ресурсов хост-системы.
+ - [Эндпоинт](../../../concepts/connect.md#endpoint): `grpcs://localhost:2135`
+ - [Размещение базы данных](../../../concepts/connect.md#database): `/local`
+ - [Аутентификация](../../../concepts/connect.md#auth-modes): Анонимная (без аутентификации)
-{% endnote %}
+{% endlist %}
diff --git a/ydb/docs/ru/core/getting_started/_includes/ydb_docker/02_install.md b/ydb/docs/ru/core/getting_started/_includes/ydb_docker/02_install.md
index dfab590a06..805ca7c73d 100644
--- a/ydb/docs/ru/core/getting_started/_includes/ydb_docker/02_install.md
+++ b/ydb/docs/ru/core/getting_started/_includes/ydb_docker/02_install.md
@@ -1,4 +1,4 @@
-## Выгрузите Docker-образ {{ ydb-short-name }} {#install}
+## Установка {#install}
Загрузите актуальную публичную версию Docker-образа:
diff --git a/ydb/docs/ru/core/getting_started/_includes/ydb_docker/03_start.md b/ydb/docs/ru/core/getting_started/_includes/ydb_docker/03_start.md
index 5f4696c349..b35b0ec5f8 100644
--- a/ydb/docs/ru/core/getting_started/_includes/ydb_docker/03_start.md
+++ b/ydb/docs/ru/core/getting_started/_includes/ydb_docker/03_start.md
@@ -1,62 +1,47 @@
-## Запустите Docker-контейнер YDB {#start}
+## Запуск {#start}
-Запустите {{ ydb-short-name }} Docker-контейнер и смонтируйте нужные директории:
+Docker-контейнер YDB использует ресурсы хост-системы (CPU, RAM) в пределах выделенных в настройках Docker.
+
+Docker-контейнер YDB хранит данные в файловой системе контейнера, разделы которой отражаются на директории в хост-системе. Приведенная ниже команда запуска контейнера создаст файлы в текущей директории, поэтому перед её запуском создайте рабочую директорию, и выполняйте запуск из неё:
```bash
-docker run -d \
- --rm \
- --name ydb-local \
- -h localhost \
- -p 2135:2135 \
- -p 8765:8765 \
- -p 2136:2136 \
+docker run -d --rm --name ydb-local -h localhost \
+ -p 2135:2135 -p 8765:8765 -p 2136:2136 \
-v $(pwd)/ydb_certs:/ydb_certs -v $(pwd)/ydb_data:/ydb_data \
-e YDB_DEFAULT_LOG_LEVEL=NOTICE \
- -e GRPC_TLS_PORT=2135 \
- -e GRPC_PORT=2136 \
- -e MON_PORT=8765 \
+ -e GRPC_TLS_PORT=2135 -e GRPC_PORT=2136 -e MON_PORT=8765 \
{{ ydb_local_docker_image}}:{{ ydb_local_docker_image_tag }}
```
-{% note info %}
-
-Монтирование директории `ydb_data` нужно для того, чтобы контейнер смог пережить рестарт контейнера. Если данная возможность не требуется директорию можно не монтировать.
-
-{% endnote %}
+При успешном запуске будет выведен идентификатор созданного контейнера.
-{% note info %}
+### Параметры запуска {#start-pars}
-Монтирование директории `ydb_certs` требуется только в случае установления безопасного соединения и не является обязательным.
+`-d`: Запустить Docker-контейнер в фоновом режиме.
-{% endnote %}
+`--rm`: Удалить контейнер после завершения его работы.
-Где:
+`--name`: Имя контейнера. Укажите `ydb-local`, чтобы приведенные ниже инструкции по остановке контейнера можно было выполнить копированием текста через буфер обмена.
-* `-d` — запустить Docker-контейнер в фоновом режиме.
-* `--rm` — удалить контейнер после завершения его работы.
-* `--name` — имя контейнера.
-* `-h` — имя хоста контейнера.
-* `-p` — опубликовать порты контейнера на хост-системе.
-* `-v` — монтировать директории хост-системы в контейнер.
-* `-e` — задать переменные окружения.
+`-h`: Имя хоста контейнера. Должно быть обязательно передано значение `localhost`, иначе контейнер будет запущен со случайным именем хоста.
-{% note info %}
+`-v`: Монтировать директории хост-системы в контейнер в виде `<директория хост-системы>:<директория монтирования в контейнере>`. Контейнер YDB использует следующие директории монтирования:
+- `/ydb_data`: Размещение данных. Если данная директория не смонтирована, то контейнер будет запущен без сохранения данных на диск хост-системы.
+- `/ydb_certs`: Размещение сертификатов для TLS соединения. Запущенный контейнер запишет туда сертификаты, которые вам нужно использовать для клиентского подключения с использованием TLS. Если данная директория не смонтирована, то вы не сможете подключиться по TLS, так как не будете обладать информацией о сертификате.
-На Apple M1 процессорах контейнер работает только в режиме в памяти. При запуске контейнера укажите переменную окружения `YDB_USE_IN_MEMORY_PDISKS=true`
+`-e`: Задать переменные окружения в виде `<имя>=<значение>`. Контейнер YDB использует следующие переменные окружения:
+- `YDB_DEFAULT_LOG_LEVEL`: Уровень логирования. Допустимые значения: `CRIT`, `ERROR`, `WARN`, `NOTICE`, `INFO`. По умолчанию `NOTICE`.
+- `GRPC_PORT`: Порт для нешифрованных соединений. По умолчанию 2136.
+- `GRPC_TLS_PORT`: Порт для соединений с использованием TLS. По умолчанию 2135.
+- `MON_PORT`: Порт для встроенного web-ui со средствами [мониторинга и интроспекции](../../../maintenance/embedded_monitoring/ydb_monitoring.md). По умолчанию 8765.
+- `YDB_PDISK_SIZE`: Размер диска для хранения данных в формате `<NUM>GB` (например, `YDB_PDISK_SIZE=128GB`). Допустимые значения: от `64GB` и выше. По умолчанию 64GB.
+- `YDB_USE_IN_MEMORY_PDISKS`: Использование дисков в памяти. Допустимые значения `true`, `false`, по умолчанию `false`. Во включенном состоянии не использует файловую систему контейнера для работы с данными, все данные хранятся только в памяти процесса, и теряются при его остановке. В настоящее время запуск контейнера на процессоре Apple M1 возможен только в этом режиме.
-{% endnote %}
+`-p`: Опубликовать порты контейнера на хост-системе. Все применяемые порты должны быть явно перечислены, даже если используются значения по умолчанию.
{% note info %}
-Инициализация Docker-контейнера, в зависимости от мощности хост-системы, может занять несколько минут. До окончания инициализации база данных будет недоступна.
+Инициализация Docker-контейнера, в зависимости от выделенных ресурсов, может занять несколько минут. До окончания инициализации база данных будет недоступна.
{% endnote %}
-Docker-контейнер {{ ydb-short-name }} поддерживает дополнительные опции, которые можно задать через переменные окружения:
-
-* `YDB_USE_IN_MEMORY_PDISKS=true` — включает возможность хранения данных целиком в памяти. В случае если данная опция включена, рестарт контейнера с локальной {{ ydb-short-name }} приведет к полной потере данных.
-* `YDB_DEFAULT_LOG_LEVEL=<уровень>` — задает уровень логирования. Доступные значения уровней: `CRIT`, `ERROR`, `WARN`, `NOTICE`, `INFO`.
-* `YDB_PDISK_SIZE=<NUM>GB` - задает размер диска для хранения данных базы данных. Например, `YDB_PDISK_SIZE=128GB`. Минимальное значение 64GB.
-* `GRPC_PORT` - порт для взаимодействия с {{ ydb-short-name }} API по gRPC без TLS.
-* `GRPC_TLS_PORT` - порт для взаимодействия с {{ ydb-short-name }} API про gRPC c поддержкой TLS.
-* `MON_PORT` - порт сo встроенными средствами мониторинга и интроспекции.
diff --git a/ydb/docs/ru/core/getting_started/_includes/ydb_docker/04_request.md b/ydb/docs/ru/core/getting_started/_includes/ydb_docker/04_request.md
index 36b294f6bc..366e5001d6 100644
--- a/ydb/docs/ru/core/getting_started/_includes/ydb_docker/04_request.md
+++ b/ydb/docs/ru/core/getting_started/_includes/ydb_docker/04_request.md
@@ -1,51 +1,23 @@
-## Выполните запрос к базе данных {#request}
+## Выполнение запросов {#request}
-Скачайте [YDB CLI](../../../getting_started/cli.md) и выполните запрос к базе данных {{ ydb-short-name }} в Docker-контейнере:
+Установите YDB CLI и выполните запросы, как описано в статье [YDB CLI - Начало работы](../../cli.md), используя эндпоинт и размещение базы данных в начале данной статьи, например:
```bash
-ydb \
- -e grpcs://localhost:2135 \
- --ca-file $(pwd)/ydb_certs/ca.pem \
- -d /local table query execute -q 'select 1;'
+ydb -e grpc://localhost:2136 -d /local scheme ls
```
-Где:
-
-* `-e` — эндпоинт базы данных.
-* `--ca-file` — путь к TLS-сертификату.
-* `-d` — имя базы данных и параметры запроса.
-
-Результат выполнения:
-
-```text
-┌─────────┐
-| column0 |
-├─────────┤
-| 1 |
-└─────────┘
-```
-
-Также можно выполнить запрос к контейнеру через порт без TLS, например:
+Для успешного соединения с использованием TLS в параметры соединения нужно добавить имя файла с сертификатом. Запрос в примере ниже должен быть выполнен из той же рабочей директории, которую вы использовали для запуска контейнера:
```bash
-ydb \
- -e grpc://localhost:2136 \
- -d /local table query execute -q 'select 1;'
+ydb -e grpcs://localhost:2135 --ca-file ydb_certs/ca.pem -d /local scheme ls
```
-
Предсобранная версия [YDB CLI](../../../reference/ydb-cli/index.md) также доступа внутри образа:
```bash
-docker exec <CONTAINER-ID> /ydb -e localhost:2136 -d /local table query execute -q 'select 1;'
+docker exec <container_id> /ydb -e localhost:2136 -d /local scheme ls
```
-Результат выполнения:
+, где
-```text
-┌─────────┐
-| column0 |
-├─────────┤
-| 1 |
-└─────────┘
-```
+`<container_id>`: идентификатор контейнера, выведенный при его [запуске](#start). \ No newline at end of file
diff --git a/ydb/docs/ru/core/getting_started/_includes/ydb_docker/05_stop.md b/ydb/docs/ru/core/getting_started/_includes/ydb_docker/05_stop.md
index 905d576c3c..ce86ccf8ed 100644
--- a/ydb/docs/ru/core/getting_started/_includes/ydb_docker/05_stop.md
+++ b/ydb/docs/ru/core/getting_started/_includes/ydb_docker/05_stop.md
@@ -1,6 +1,6 @@
-## Остановите Docker-контейнер {#stop}
+## Остановка {#stop}
По окончании работы остановите Docker-контейнер:
diff --git a/ydb/docs/ru/core/getting_started/_includes/yql.md b/ydb/docs/ru/core/getting_started/_includes/yql.md
index b463d037ee..8195a1b7c0 100644
--- a/ydb/docs/ru/core/getting_started/_includes/yql.md
+++ b/ydb/docs/ru/core/getting_started/_includes/yql.md
@@ -29,7 +29,7 @@ YDB предоставляет следующие способы отправк
Текст приведенных ниже скриптов нужно сохранить в файл. Назовите его `script.yql`, чтобы команды в примерах можно было выполнить простым копированием через буфер обмена. Далее выполните команду `scripting yql` с указанием использования профиля `db1` и чтения скрипта из файла `script.yql`:
``` bash
-{{ ydb-cli }} --profile db1 scripting yql -f script.yml
+{{ ydb-cli }} --profile db1 scripting yql -f script.yql
```
## Работа со схемой данных {#ddl}
@@ -188,4 +188,8 @@ $ {{ ydb-cli }} --profile db1 scripting yql -f script.yql -p '$seriesId=1' -p '$
## Туториал YQL {#tutorial}
-Вы можете продолжить изучение основных возможностей YQL, выполняя задания из [Туториала YQL](../../yql/tutorial/index.md). \ No newline at end of file
+Вы можете изучить больше примеров использования YQL, выполняя задания из [Туториала YQL](../../yql/tutorial/index.md).
+
+## Продолжение знакомства с YDB {#next}
+
+Перейдите к статье [YDB SDK - Начало работы](../sdk.md) для продолжения знакомства с YDB. \ No newline at end of file
diff --git a/ydb/docs/ru/core/getting_started/toc_i.yaml b/ydb/docs/ru/core/getting_started/toc_i.yaml
index b9e00287af..77c8fcf603 100644
--- a/ydb/docs/ru/core/getting_started/toc_i.yaml
+++ b/ydb/docs/ru/core/getting_started/toc_i.yaml
@@ -5,11 +5,11 @@ items:
- include: { mode: link, path: _includes/index/toc_network.yaml }
- name: Аутентификация
href: auth.md
-- name: Интерфейс командной строки (CLI)
+- name: Интерфейс командной строки YDB CLI
href: cli.md
- name: Язык запросов YQL
href: yql.md
-- name: SDK для разных языков программирования
+- name: YDB SDK
href: sdk.md
- name: Самостоятельное развертывание
items:
diff --git a/ydb/docs/ru/core/reference/ydb-cli/_includes/commands.md b/ydb/docs/ru/core/reference/ydb-cli/_includes/commands.md
index 1343a2a1d6..ce9719d0fe 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/_includes/commands.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/_includes/commands.md
@@ -71,5 +71,6 @@ tools restore | Восстановление из файловой систем
[update](../commands/service.md) | Обновление YDB CLI
[version](../commands/service.md) | Вывод информации о версии YDB CLI
{% endif %}
+[workload](../commands/workload/index.md) | Генерация нагрузки
yql | Выполнение YQL-скрипта (с поддержкой стриминга)
diff --git a/ydb/docs/ru/core/reference/ydb-sdk/example/_includes/index.md b/ydb/docs/ru/core/reference/ydb-sdk/example/_includes/index.md
index ea1ae0d6e4..1a8d452d0a 100644
--- a/ydb/docs/ru/core/reference/ydb-sdk/example/_includes/index.md
+++ b/ydb/docs/ru/core/reference/ydb-sdk/example/_includes/index.md
@@ -3,15 +3,13 @@
В данном разделе разбирается код однотипного тестового приложения, реализованного с использованием YDB SDK на разных языках программирования:
{% if oss %}
-- C++ [https://github.com/ydb-platform/ydb/tree/main/ydb/public/sdk/cpp/examples/basic_example](https://github.com/ydb-platform/ydb/tree/main/ydb/public/sdk/cpp/examples/basic_example)
+- [C++](../example-cpp.md)
{% endif %}
-- С# (.NET) [https://github.com/ydb-platform/ydb-dotnet-examples](https://github.com/ydb-platform/ydb-dotnet-examples)
-- Go [https://github.com/ydb-platform/ydb-go-examples/tree/master/basic](https://github.com/ydb-platform/ydb-go-examples/tree/master/basic)
-- Java [https://github.com/yandex-cloud/ydb-java-sdk/tree/master/examples/maven_project](https://github.com/yandex-cloud/ydb-java-sdk/tree/master/examples/maven_project)
-- Node.js [https://github.com/ydb-platform/ydb-nodejs-sdk/tree/master/examples/basic-example-v1](https://github.com/ydb-platform/ydb-nodejs-sdk/tree/master/examples/basic-example-v1)
-- Python [https://github.com/yandex-cloud/ydb-python-sdk/tree/master/examples/basic_example_v1](https://github.com/yandex-cloud/ydb-python-sdk/tree/master/examples/basic_example_v1)
-
-Инструкции по скачиванию и запуску тестового приложения находятся в файле `readme.md` по приведенным выше ссылкам.
+- [С# (.NET)](../example-dotnet.md)
+- [Go](../go/index.md)
+- [Java](../example-java.md)
+- [Node.js](../example-nodejs.md)
+- [Python](../python/index.md)
Тестовое приложение выполняет следующие шаги:
diff --git a/ydb/docs/ru/core/reference/ydb-sdk/example/_includes/steps/01_init.md b/ydb/docs/ru/core/reference/ydb-sdk/example/_includes/steps/01_init.md
index 11b242640c..f5181b2234 100644
--- a/ydb/docs/ru/core/reference/ydb-sdk/example/_includes/steps/01_init.md
+++ b/ydb/docs/ru/core/reference/ydb-sdk/example/_includes/steps/01_init.md
@@ -1,6 +1,6 @@
## Инициализация соединения с базой данных {#init}
-Для взаимодействия с {{ ydb-short-name }} необходимо создать экземпляр драйвера, клиента и сессии:
+Для взаимодействия с {{ ydb-short-name }} создается экземпляр драйвера, клиента и сессии:
* Драйвер {{ ydb-short-name }} отвечает за взаимодействие приложения и {{ ydb-short-name }} на транспортном уровне. Драйвер должен существовать на всем протяжении жизненного цикла работы с {{ ydb-short-name }} и должен быть инициализирован перед созданием клиента и сессии.
* Клиент {{ ydb-short-name }} работает поверх драйвера {{ ydb-short-name }} и отвечает за работу с сущностями и транзакциями.
diff --git a/ydb/docs/ru/core/reference/ydb-sdk/example/go/index.md b/ydb/docs/ru/core/reference/ydb-sdk/example/go/index.md
index dd2413e472..e52d6e3517 100644
--- a/ydb/docs/ru/core/reference/ydb-sdk/example/go/index.md
+++ b/ydb/docs/ru/core/reference/ydb-sdk/example/go/index.md
@@ -1,6 +1,6 @@
# Приложение на Go
-На этой странице подробно разбирается код [тестового приложения](https://github.com/ydb-platform/ydb-go-examples/tree/master/cmd/basic), использующего [Go SDK](https://github.com/ydb-platform/ydb-go-sdk/v3) {{ ydb-short-name }}.
+На этой странице подробно разбирается код [тестового приложения](https://github.com/ydb-platform/ydb-go-examples/tree/master/basic), использующего [Go SDK](https://github.com/ydb-platform/ydb-go-sdk/v3) {{ ydb-short-name }}.
## Скачивание и запуск {#download}