aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorbazeltsev <bazeltsev@yandex-team.ru>2022-03-03 16:43:28 +0300
committerbazeltsev <bazeltsev@yandex-team.ru>2022-03-03 16:43:28 +0300
commite9048cd937922fb544a4050977ec20c350dceb98 (patch)
treea1fda5b0391df336e2c2ad719c21a17c5954a324
parentcf8e905de16e491aa857863eaa8b1f6f55f76a79 (diff)
downloadydb-e9048cd937922fb544a4050977ec20c350dceb98.tar.gz
Вычитать core ru - getting_started
copy to kikimr updated ref:da5c0b2526e5e998714b23f0bbcdad175e812412
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/auth.md4
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/cli.md40
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/cli/ls_example_generic.md14
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/cli/ls_example_local.md2
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/create_db.md10
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/index.md1
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/index/create_db.md2
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/index/yql.md2
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/sdk.md12
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/useful_links.md7
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/ydb_docker/01_intro.md12
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/ydb_docker/03_start.md41
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/ydb_docker/04_request.md4
-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.md69
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/yql/ui_embedded_execute.md2
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/yql/ui_embedded_prompt.md2
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/yql/ui_embedded_scheme_ls.md2
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/yql/ui_execute.md3
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/yql/ui_prompt.md3
-rw-r--r--ydb/docs/ru/core/getting_started/ydb_local.md4
21 files changed, 118 insertions, 120 deletions
diff --git a/ydb/docs/ru/core/getting_started/_includes/auth.md b/ydb/docs/ru/core/getting_started/_includes/auth.md
index b475cac608..9141f7fc80 100644
--- a/ydb/docs/ru/core/getting_started/_includes/auth.md
+++ b/ydb/docs/ru/core/getting_started/_includes/auth.md
@@ -2,8 +2,8 @@
Разворачиваемая сценариями самостоятельного развертывания локальная база данных YDB не требует аутентификации, то есть работает в [анонимном режиме](../../concepts/connect.md#auth-modes).
-Полная информация о всех доступных способах аутентификации приведена в статье [Соединение с базой данных](../../concepts/connect.md) в разделе "Концепции".
+Полная информация о всех доступных способах аутентификации приведена в статье [Соединение с базой данных](../../concepts/connect.md) в разделе Концепции.
## Продолжение знакомства с YDB {#next}
-Перейдите к статье [YDB CLI - Начало работы](../cli.md) для продолжения знакомства с YDB.
+Перейдите к статье [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 6c5ed17970..88f7b0726c 100644
--- a/ydb/docs/ru/core/getting_started/_includes/cli.md
+++ b/ydb/docs/ru/core/getting_started/_includes/cli.md
@@ -2,10 +2,10 @@
## Предварительные требования {#prerequisites}
-Для выполнения команд через CLI вам потребуются параметры соединения с базой данных, которые вы можете получить при её [создании](../create_db.md):
+Для выполнения команд через CLI вам потребуются параметры соединения с базой данных, которые вы можете получить при ее [создании](../create_db.md):
-- [Эндпоинт](../../concepts/connect.md#endpoint)
-- [Имя базы данных](../../concepts/connect.md#database)
+* [Эндпоинт](../../concepts/connect.md#endpoint)
+* [Имя базы данных](../../concepts/connect.md#database)
Также вам может потребоваться токен или логин/пароль, если база данных требует [аутентификации](../auth.md). Для успешного исполнения сценария ниже вам нужно выбрать вариант их сохранения в переменной окружения.
@@ -15,13 +15,13 @@
Проверьте успешность установки YDB CLI запуском с параметром `--help`:
-``` bash
+```bash
{{ ydb-cli }} --help
```
В ответ должно быть выведено приветственное сообщение, краткое описание синтаксиса, и перечень доступных команд:
-``` text
+```text
YDB client
Usage: ydb [options...] <subcommand>
@@ -40,7 +40,7 @@ ydb
Для проверки успешности соединения можно использовать команду [получения перечня объектов](../../reference/ydb-cli/commands/scheme-ls.md) в базе данных `scheme ls`:
-``` bash
+```bash
{{ ydb-cli }} -e <endpoint> -d <database> scheme ls
```
@@ -50,18 +50,19 @@ ydb
## Создание профиля соединения {#profile}
-Чтобы не писать параметры соединения каждый раз при вызове YDB CLI, воспользуйтесь [профилем](../../reference/ydb-cli/profile/index.md). Создание предложенного ниже профиля позволит вам также копировать дальнейшие команды через буфер обмена без их редактирования, вне зависимости от того, на какой базе данных вы проходите сценарий "Начала работы".
+Чтобы не писать параметры соединения каждый раз при вызове YDB CLI, воспользуйтесь [профилем](../../reference/ydb-cli/profile/index.md). Создание предложенного ниже профиля позволит вам также копировать дальнейшие команды через буфер обмена без их редактирования, вне зависимости от того, на какой базе данных вы проходите сценарий начала работы.
-[Создайте профиль](../../reference/ydb-cli/profile/create.md) `db1` следующей командой:
+[Создайте профиль](../../reference/ydb-cli/profile/create.md) `db1` следующей командой:
-``` bash
+```bash
{{ ydb-cli }} config profile create db1
```
В интерактивном режиме будут запрошены параметры соединения, которые нужно связать с данным профилем. Используйте для них проверенные на [предыдущем шаге](#ping) значения.
Проверьте работоспособность профиля командой `scheme ls`:
-``` bash
+
+```bash
{{ ydb-cli }} --profile db1 scheme ls
```
@@ -69,28 +70,31 @@ ydb
Команда {{ ydb-short-name }} CLI `scripting yql` позволяет выполнить любую команду (как DDL так и DML) на [языке YQL](../../yql/reference/index.md) - диалекте SQL, поддерживаемом {{ ydb-short-name }}:
-``` bash
+```bash
{{ ydb-cli }} --profile <profile_name> yql -s <yql_request>
```
Например:
-- Создание таблицы
- ``` bash
+* Создание таблицы:
+
+ ```bash
{{ ydb-cli }} --profile db1 yql -s "create table t1( id uint64, primary key(id))"
```
-- Добавление записи
- ``` bash
+* Добавление записи:
+
+ ```bash
{{ ydb-cli }} --profile db1 yql -s "insert into t1(id) values (1)"
```
-- Выборка данных
- ``` bash
+* Выборка данных:
+
+ ```bash
{{ ydb-cli }} --profile db1 yql -s "select * from t1"
```
-Если вы получаете ошибку `Profile db1 does not exist` - значит вы не создали его на [предыдущем шаге](#profile).
+Если вы получаете ошибку `Profile db1 does not exist`, значит вы не создали его на [предыдущем шаге](#profile).
## Специализированные команды CLI {#ydb-api}
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 ca0d917c58..26e6e6b7bc 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
@@ -1,10 +1,12 @@
-Например, если:
-* Эндпоинт: grpc://ydb.example.com:2136
-* Имя базы данных: /john/db1
-* База данных не требует аутентификации, или задана нужная переменная окружения, как описано [здесь](../../auth.md).
-* База данных только что создана и не содержит объектов
+Например, если:
+
+* Эндпоинт: `grpc://ydb.example.com:2136`;
+* Имя базы данных: `/john/db1`;
+* База данных не требует аутентификации, или задана нужная переменная окружения, как описано [здесь](../../auth.md);
+* База данных только что создана и не содержит объектов;
+
+то команда будет выглядеть следующим образом:
-То команда и результат выполнения будут выглядеть следующим образом:
``` bash
{{ ydb-cli }} -e grpc://ydb.example.com:2136 -d /john/db1 scheme ls
```
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 de1eb89c88..5cd03c4f47 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
@@ -5,5 +5,3 @@
``` bash
{{ 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 f307871a48..af44fb7ecc 100644
--- a/ydb/docs/ru/core/getting_started/_includes/create_db.md
+++ b/ydb/docs/ru/core/getting_started/_includes/create_db.md
@@ -1,4 +1,4 @@
-# Создание базы данных - Начало работы
+# Создание базы данных - начало работы
Подробная информация о базах данных находится в статье [Термины и определения - База данных](../../concepts/databases.md#database) в разделе Концепции.
@@ -8,10 +8,10 @@
{{ ydb-short-name }} может быть развернута самостоятельно тремя способами:
-* [С использованием Docker](../ydb_docker.md).
-* [В Kubernetes](../../deploy/orchestrated/concepts.md).
-* [Локально из скачанного исполняемого файла](../ydb_local.md).
+* [С использованием Docker](../ydb_docker.md)
+* [В Kubernetes](../../deploy/orchestrated/concepts.md)
+* [Локально из скачанного исполняемого файла](../ydb_local.md)
## Продолжение знакомства с YDB {#next}
-После создания базы данных перейдите к статье [Аутентификация - Начало работы](../auth.md) для продолжения знакомства с YDB. \ No newline at end of file
+После создания базы данных перейдите к статье [Аутентификация - Начало работы](../auth.md) для продолжения знакомства с YDB.
diff --git a/ydb/docs/ru/core/getting_started/_includes/index.md b/ydb/docs/ru/core/getting_started/_includes/index.md
index e80bce9695..077c56ab67 100644
--- a/ydb/docs/ru/core/getting_started/_includes/index.md
+++ b/ydb/docs/ru/core/getting_started/_includes/index.md
@@ -11,4 +11,3 @@
{% include [yql.md](index/yql.md) %}
{% include [sdk.md](index/sdk.md) %}
-
diff --git a/ydb/docs/ru/core/getting_started/_includes/index/create_db.md b/ydb/docs/ru/core/getting_started/_includes/index/create_db.md
index 12cffcad0e..6ecbe05b9e 100644
--- a/ydb/docs/ru/core/getting_started/_includes/index/create_db.md
+++ b/ydb/docs/ru/core/getting_started/_includes/index/create_db.md
@@ -1 +1 @@
-- [Создание базы данных](../../create_db.md) - запустите самостоятельно OpenSource БД {{ ydb-short-name }} \ No newline at end of file
+* [Создание базы данных](../../create_db.md) - запустите самостоятельно OpenSource БД {{ ydb-short-name }}.
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 29882b4a0b..9c84fcebc0 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 - основным языком запросов к {{ ydb-short-name }}, диалектом SQL.
+* [YQL](../../yql.md) — познакомьтесь с YQL — основным языком запросов к {{ ydb-short-name }}, диалектом SQL.
diff --git a/ydb/docs/ru/core/getting_started/_includes/sdk.md b/ydb/docs/ru/core/getting_started/_includes/sdk.md
index e11b48048f..5aabebc2b2 100644
--- a/ydb/docs/ru/core/getting_started/_includes/sdk.md
+++ b/ydb/docs/ru/core/getting_started/_includes/sdk.md
@@ -1,16 +1,14 @@
-# {{ ydb-short-name }} SDK - Начало работы
+# {{ ydb-short-name }} SDK - начало работы
{{ ydb-short-name }} SDK - набор программных компонентов, поддерживающих работу с базами данных {{ ydb-short-name }} для приложений на разных языках программирования.
Выполните следующие шаги для запуска простейшего приложения, использующего {{ ydb-short-name }}:
-1. [Установите {{ ydb-short-name }} SDK](../../reference/ydb-sdk/install.md) для нужного языка программирования
+1. [Установите {{ ydb-short-name }} SDK](../../reference/ydb-sdk/install.md) для нужного языка программирования.
-2. Скачайте и запустите готовое тестовое приложение, использующее SDK для установленного языка программирования, и изучите его код:
+1. Скачайте и запустите готовое тестовое приложение, использующее SDK для установленного языка программирования, и изучите его код:
- - [Python](../../reference/ydb-sdk/example/python/index.md)
- - [Go](../../reference/ydb-sdk/example/go/index.md)
+ * [Python](../../reference/ydb-sdk/example/python/index.md)
+ * [Go](../../reference/ydb-sdk/example/go/index.md)
Полная информация о {{ ydb-short-name }} SDK находится в разделе [Работа с {{ ydb-short-name }} SDK](../../reference/ydb-sdk/index.md).
-
-
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 0f4a83c4bc..c54b805c05 100644
--- a/ydb/docs/ru/core/getting_started/_includes/useful_links.md
+++ b/ydb/docs/ru/core/getting_started/_includes/useful_links.md
@@ -1,6 +1,11 @@
# Полезные ссылки
{% if oss %}
-* [Сайт {{ ydb-short-name }} OpenSource](https://ydb.tech){% endif %}
+
+* [Сайт {{ ydb-short-name }} OpenSource](https://ydb.tech)
+
+{% endif %}
+
* [Консоль управления в 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/ydb_docker/01_intro.md b/ydb/docs/ru/core/getting_started/_includes/ydb_docker/01_intro.md
index 91bc488365..48934d667a 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
@@ -8,14 +8,14 @@
- gRPC
- - [Эндпоинт](../../../concepts/connect.md#endpoint): `grpc://localhost:2136`
- - [Размещение базы данных](../../../concepts/connect.md#database): `/local`
- - [Аутентификация](../../../concepts/connect.md#auth-modes): Анонимная (без аутентификации)
+ * [эндпоинт](../../../concepts/connect.md#endpoint): `grpc://localhost:2136`;
+ * [размещение базы данных](../../../concepts/connect.md#database): `/local`;
+ * [аутентификация](../../../concepts/connect.md#auth-modes): Анонимная (без аутентификации).
- gRPCs/TLS
- - [Эндпоинт](../../../concepts/connect.md#endpoint): `grpcs://localhost:2135`
- - [Размещение базы данных](../../../concepts/connect.md#database): `/local`
- - [Аутентификация](../../../concepts/connect.md#auth-modes): Анонимная (без аутентификации)
+ * [эндпоинт](../../../concepts/connect.md#endpoint): `grpcs://localhost:2135`;
+ * [размещение базы данных](../../../concepts/connect.md#database): `/local`;
+ * [аутентификация](../../../concepts/connect.md#auth-modes): Анонимная (без аутентификации).
{% endlist %}
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 ea780712e8..90972105ac 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,8 +1,8 @@
## Запуск {#start}
-Docker-контейнер YDB использует ресурсы хост-системы (CPU, RAM) в пределах выделенных настройками Docker.
+Docker-контейнер YDB использует ресурсы хост-системы (CPU, RAM) в пределах, выделенных настройками Docker.
-Docker-контейнер YDB хранит данные в файловой системе контейнера, разделы которой отражаются на директории в хост-системе. Приведенная ниже команда запуска контейнера создаст файлы в текущей директории, поэтому перед запуском создайте рабочую директорию и выполняйте запуск из неё:
+Docker-контейнер YDB хранит данные в файловой системе контейнера, разделы которой отражаются на директории в хост-системе. Приведенная ниже команда запуска контейнера создаст файлы в текущей директории, поэтому перед запуском создайте рабочую директорию и выполняйте запуск из нее:
```bash
docker run -d --rm --name ydb-local -h localhost \
@@ -17,31 +17,24 @@ docker run -d --rm --name ydb-local -h localhost \
### Параметры запуска {#start-pars}
-`-d`: Запустить Docker-контейнер в фоновом режиме.
-
-`--rm`: Удалить контейнер после завершения его работы.
-
-`--name`: Имя контейнера. Укажите `ydb-local`, чтобы приведенные ниже инструкции по остановке контейнера можно было выполнить копированием текста через буфер обмена.
-
-`-h`: Имя хоста контейнера. Должно быть обязательно передано значение `localhost`, иначе контейнер будет запущен со случайным именем хоста.
-
-`-v`: Монтировать директории хост-системы в контейнер в виде `<директория хост-системы>:<директория монтирования в контейнере>`. Контейнер YDB использует следующие директории монтирования:
-- `/ydb_data`: Размещение данных. Если данная директория не смонтирована, то контейнер будет запущен без сохранения данных на диск хост-системы.
-- `/ydb_certs`: Размещение сертификатов для TLS соединения. Запущенный контейнер запишет туда сертификаты, которые вам нужно использовать для клиентского подключения с использованием TLS. Если данная директория не смонтирована, то вы не сможете подключиться по TLS, так как не будете обладать информацией о сертификате.
-
-`-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 возможен только в этом режиме.
-
-`-p`: Опубликовать порты контейнера на хост-системе. Все применяемые порты должны быть явно перечислены, даже если используются значения по умолчанию.
+* `-d` — запустить Docker-контейнер в фоновом режиме.
+* `--rm` — удалить контейнер после завершения его работы.
+* `--name` — имя контейнера. Укажите `ydb-local`, чтобы приведенные ниже инструкции по остановке контейнера можно было выполнить копированием текста через буфер обмена.
+* `-h` — имя хоста контейнера. Должно быть обязательно передано значение `localhost`, иначе контейнер будет запущен со случайным именем хоста.
+* `-v` — монтировать директории хост-системы в контейнер в виде `<директория хост-системы>:<директория монтирования в контейнере>`. Контейнер YDB использует следующие директории монтирования:
+ * `/ydb_data` — размещение данных. Если данная директория не смонтирована, то контейнер будет запущен без сохранения данных на диск хост-системы.
+ * `/ydb_certs` — размещение сертификатов для TLS-соединения. Запущенный контейнер запишет туда сертификаты, которые вам нужно использовать для клиентского подключения с использованием TLS. Если данная директория не смонтирована, то вы не сможете подключиться по TLS, так как не будете обладать информацией о сертификате.
+* `-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 возможен только в этом режиме.
+* `-p` — опубликовать порты контейнера на хост-системе. Все применяемые порты должны быть явно перечислены, даже если используются значения по умолчанию.
{% note info %}
Инициализация Docker-контейнера, в зависимости от выделенных ресурсов, может занять несколько минут. До окончания инициализации база данных будет недоступна.
{% endnote %}
-
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 366e5001d6..ab52267cd2 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
@@ -18,6 +18,6 @@ ydb -e grpcs://localhost:2135 --ca-file ydb_certs/ca.pem -d /local scheme ls
docker exec <container_id> /ydb -e localhost:2136 -d /local scheme ls
```
-, где
+где
-`<container_id>`: идентификатор контейнера, выведенный при его [запуске](#start). \ No newline at end of file
+`<container_id>` — идентификатор контейнера, выведенный при его [запуске](#start).
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 ce86ccf8ed..46e8c4ac36 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,5 +1,3 @@
-
-
## Остановка {#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 8f749b500a..349227c057 100644
--- a/ydb/docs/ru/core/getting_started/_includes/yql.md
+++ b/ydb/docs/ru/core/getting_started/_includes/yql.md
@@ -1,4 +1,4 @@
-# YQL - Начало работы
+# YQL - начало работы
## Введение {#intro}
@@ -6,7 +6,7 @@ YQL - язык запросов к базе данных {{ ydb-short-name }},
Полная информация по синтаксису YQL находится в [справочнике по YQL](../../yql/reference/index.md).
-Приведенные ниже примеры формируют сценарий знакомства с YQL, и предполагают последовательное выполнение: запросы в разделе ["Работа с данными"](#dml) обращаются к данным в таблицах, созданным в разделе ["Работа со схемой данных"](#ddl). Выполняйте шаги последовательно, чтобы скопированные через буфер обмена примеры успешно исполнялись.
+Приведенные ниже примеры формируют сценарий знакомства с YQL, и предполагают последовательное выполнение: запросы в разделе [Работа с данными](#dml) обращаются к данным в таблицах, созданным в разделе [Работа со схемой данных](#ddl). Выполняйте шаги последовательно, чтобы скопированные через буфер обмена примеры успешно исполнялись.
Базовый интерфейс {{ ydb-short-name }} YQL принимает на вход не одну команду, а скрипт, который может состоять из множества команд.
@@ -16,19 +16,19 @@ YQL - язык запросов к базе данных {{ ydb-short-name }},
{% include [yql/ui_prompt.md](yql/ui_prompt.md) %}
-- [{{ ydb-short-name }} CLI](#cli)
-
-- [{{ ydb-short-name }} SDK](../sdk.md)
+* [{{ ydb-short-name }} CLI](#cli)
+* [{{ ydb-short-name }} SDK](../sdk.md)
{% include [yql/ui_execute.md](yql/ui_execute.md) %}
### {{ ydb-short-name }} CLI {#cli}
Для исполнения скриптов через {{ ydb-short-name }} CLI нужно предварительно:
-- Выполнить [установку CLI](../cli.md#install)
-- Определить и проверить [параметры соединения с БД](../cli#scheme-ls)
-- [Создать профиль `db1`](../cli.md#profile), настроенный на соединение с вашей БД.
+
+* Выполнить [установку CLI](../cli.md#install).
+* Определить и проверить [параметры соединения с БД](../cli#scheme-ls).
+* [Создать профиль `db1`](../cli.md#profile), настроенный на соединение с вашей БД.
Текст приведенных ниже скриптов нужно сохранить в файл. Назовите его `script.yql`, чтобы команды в примерах можно было выполнить простым копированием через буфер обмена. Далее выполните команду `{{ ydb-cli }} yql` с указанием использования профиля `db1` и чтения скрипта из файла `script.yql`:
@@ -74,13 +74,13 @@ CREATE TABLE episodes (
);
```
-Описание всех возможностей работы с таблицами приведены в разделах документаци по YQL:
+Описание всех возможностей работы с таблицами приведены в разделах документации по YQL:
-- [`CREATE TABLE`](../../yql/reference/syntax/create_table.md) - создание таблицы и определение начальных параметров
-- [`ALTER TABLE`](../../yql/reference/syntax/alter_table.md) - изменение состава колонок таблицы и её параметров
-- [`DROP TABLE`](../../yql/reference/syntax/drop_table.md) - удаление таблицы
+* [CREATE TABLE](../../yql/reference/syntax/create_table.md) — создание таблицы и определение начальных параметров.
+* [ALTER TABLE](../../yql/reference/syntax/alter_table.md) — изменение состава колонок таблицы и ее параметров.
+* [DROP TABLE](../../yql/reference/syntax/drop_table.md) — удаление таблицы.
-Для исполнения скрипта через {{ ydb-short-name }} CLI выполните инструкции, приведенные в пункте ["Исполнение в {{ ydb-short-name }} CLI"](#cli) данной статьи.
+Для исполнения скрипта через {{ ydb-short-name }} CLI выполните инструкции, приведенные в пункте [Исполнение в {{ ydb-short-name }} CLI](#cli) данной статьи.
### Получение перечня существующих таблиц в БД {#scheme-ls}
@@ -88,7 +88,7 @@ CREATE TABLE episodes (
{% include [yql/ui_scheme_ls.md](yql/ui_scheme_ls.md) %}
-Для получения перечня существующих таблиц в БД через {{ ydb-short-name }} CLI убедитесь, что выполнены предварительные требования пункта ["Исполнение в {{ ydb-short-name }} CLI"](#cli) данной статьи, и выполните [команду `scheme ls`](../cli.md#ping):
+Для получения перечня существующих таблиц в БД через {{ ydb-short-name }} CLI убедитесь, что выполнены предварительные требования пункта [Исполнение в {{ ydb-short-name }} CLI](#cli) данной статьи, и выполните [команду `scheme ls`](../cli.md#ping):
``` bash
{{ ydb-cli }} --profile db1 scheme ls
@@ -96,17 +96,17 @@ CREATE TABLE episodes (
## Работа с данными {#dml}
-Команды исполнения YQL запросов и скриптов в YDB CLI и web-интерфейсе работают в режиме **Autocommit**, то есть после успешного исполнения транзакция подтверждается автоматически.
+Команды исполнения YQL запросов и скриптов в YDB CLI и web-интерфейсе работают в режиме Autocommit, то есть после успешного исполнения транзакция подтверждается автоматически.
-### UPSERT : Запись данных {#upsert}
+### UPSERT — запись данных {#upsert}
-Самым эффективным способом записи данных в {{ ydb-short-name }} является [команда `UPSERT`](../../yql/reference/syntax/upsert_into.md). Она выполняет запись новых данных по первичным ключам независимо от того, существовали ли данные по этим ключам ранее в таблице. В результате, в отличие от привычных `INSERT` и `UPDATE`, её исполнение не требует на сервере предварительного чтения данных для проверки уникальности ключа. Всегда при работе с {{ ydb-short-name }} рассматривайте `UPSERT` как основной способ записи данных, используя другие команды только при необходимости.
+Самым эффективным способом записи данных в {{ ydb-short-name }} является [команда `UPSERT`](../../yql/reference/syntax/upsert_into.md). Она выполняет запись новых данных по первичным ключам независимо от того, существовали ли данные по этим ключам ранее в таблице. В результате, в отличие от привычных `INSERT` и `UPDATE`, ее исполнение не требует на сервере предварительного чтения данных для проверки уникальности ключа. Всегда при работе с {{ ydb-short-name }} рассматривайте `UPSERT` как основной способ записи данных, используя другие команды только при необходимости.
Все команды записи данных в {{ ydb-short-name }} поддерживают работу как с выборками, так и со множеством записей, передаваемых непосредственно с запросе.
Добавим данные в созданные ранее таблицы:
-``` yql
+```yql
UPSERT INTO series (series_id, title, release_date, series_info)
VALUES
(
@@ -138,18 +138,19 @@ VALUES
(2, 1, 2, "The Cap Table", Date("2014-04-13"))
;
```
-Для исполнения скрипта через {{ ydb-short-name }} CLI выполните инструкции, приведенные в пункте ["Исполнение в {{ ydb-short-name }} CLI"](#cli) данной статьи.
+
+Для исполнения скрипта через {{ ydb-short-name }} CLI выполните инструкции, приведенные в пункте [Исполнение в {{ ydb-short-name }} CLI](#cli) данной статьи.
Вы можете дополнительно ознакомиться с командами записи данных в справочнике YQL:
-- [`INSERT`](../../yql/reference/syntax/insert_into.md) - добавление записей
-- [`REPLACE`](../../yql/reference/syntax/replace_into.md) - добавление/изменение записей
-- [`UPDATE`](../../yql/reference/syntax/update.md) - изменение указанных полей
-- [`UPSERT`](../../yql/reference/syntax/upsert_into.md) - добавление записей/изменение указанных полей
+* [INSERT](../../yql/reference/syntax/insert_into.md) — добавление записей.
+* [REPLACE](../../yql/reference/syntax/replace_into.md) — добавление/изменение записей.
+* [UPDATE](../../yql/reference/syntax/update.md) — изменение указанных полей.
+* [UPSERT](../../yql/reference/syntax/upsert_into.md) — добавление записей/изменение указанных полей.
-### SELECT : Выборка данных {#select}
+### SELECT — выборка данных {#select}
-Запросите выборку записанных на предыдущем шаге данных:
+Запросите выборку записанных на предыдущем шаге данных:
```sql
SELECT
@@ -158,20 +159,22 @@ SELECT
release_date
FROM series;
```
+
или
+
```sql
SELECT * FROM episodes;
```
Если в скрипте YQL будет несколько команд `SELECT`, то в результате его исполнения будет возвращено несколько выборок, к каждой из которых можно обратиться отдельно. Выполните приведенные выше команды `SELECT`, объединенные в одном скрипте.
-Для исполнения скрипта через {{ ydb-short-name }} CLI выполните инструкции, приведенные в пункте ["Исполнение в {{ ydb-short-name }} CLI"](#cli) данной статьи.
+Для исполнения скрипта через {{ ydb-short-name }} CLI выполните инструкции, приведенные в пункте [Исполнение в {{ ydb-short-name }} CLI](#cli) данной статьи.
Вы можете дополнительно ознакомиться с полным описанием команд, связанных с выборкой данных, в справочнике YQL:
-- [`SELECT`](../../yql/reference/syntax/select.md) - выполнение выборки данных
-- [`SELECT ... JOIN`](../../yql/reference/syntax/join.md) - соединение таблиц при выполнении выборки данных
-- [`SELECT ... GROUP BY`](../../yql/reference/syntax/group_by.md) - группировка данных при выполнении выборки
+* [SELECT](../../yql/reference/syntax/select.md) — выполнение выборки данных.
+* [SELECT ... JOIN](../../yql/reference/syntax/join.md) — соединение таблиц при выполнении выборки данных.
+* [SELECT ... GROUP BY](../../yql/reference/syntax/group_by.md) — группировка данных при выполнении выборки.
### Параметризованные запросы {#param}
@@ -179,13 +182,13 @@ SELECT * FROM episodes;
Для определения параметров в тексте запроса YQL применяется [команда DECLARE](../../yql/reference/syntax/declare.md).
-Описание методов исполнения параметризованных запросов {{ ydb-short-name }} SDK доступно в разделе [Тестовый пример](../../reference/ydb-sdk/example/index.md), в секции "Параметризованные запросы" для нужного языка программирования.
+Описание методов исполнения параметризованных запросов {{ ydb-short-name }} SDK доступно в разделе [Тестовый пример](../../reference/ydb-sdk/example/index.md), в секции Параметризованные запросы для нужного языка программирования.
При отладке параметризованного запроса в {{ ydb-short-name }} SDK вы можете проверить его работоспособность вызовом {{ ydb-short-name }} CLI, скопировав полный текст запроса без каких-либо корректировок, и задав значения параметров.
Сохраните скрипт выполнения параметризованного запроса в текстовом файле `script.yql`:
-``` sql
+```sql
DECLARE $seriesId AS Uint64;
DECLARE $seasonId AS Uint64;
@@ -195,7 +198,7 @@ INNER JOIN series AS sr ON sa.series_id = sr.series_id
WHERE sa.series_id = $seriesId AND sa.season_id = $seasonId;
```
-Для выполнения параметризованной выборки убедитесь, что выполнены предварительные требования пункта ["Исполнение в {{ ydb-short-name }} CLI"](#cli) данной статьи, и выполните следующую команду:
+Для выполнения параметризованной выборки убедитесь, что выполнены предварительные требования пункта [Исполнение в {{ ydb-short-name }} CLI](#cli) данной статьи, и выполните следующую команду:
``` bash
{{ ydb-cli }} --profile db1 yql -f script.yql -p '$seriesId=1' -p '$seasonId=1'
@@ -209,4 +212,4 @@ WHERE sa.series_id = $seriesId AND sa.season_id = $seasonId;
## Продолжение знакомства с YDB {#next}
-Перейдите к статье [YDB SDK - Начало работы](../sdk.md) для продолжения знакомства с YDB. \ No newline at end of file
+Перейдите к статье [YDB SDK - Начало работы](../sdk.md) для продолжения знакомства с YDB.
diff --git a/ydb/docs/ru/core/getting_started/_includes/yql/ui_embedded_execute.md b/ydb/docs/ru/core/getting_started/_includes/yql/ui_embedded_execute.md
index 26543ba2fe..b988a0d0bf 100644
--- a/ydb/docs/ru/core/getting_started/_includes/yql/ui_embedded_execute.md
+++ b/ydb/docs/ru/core/getting_started/_includes/yql/ui_embedded_execute.md
@@ -6,4 +6,4 @@
![embedded_query](../../_assets/embedded_query.png)
-Для выполнения YQL-скрипта нажмите кнопку **Run Script**. \ No newline at end of file
+Для выполнения YQL-скрипта нажмите кнопку **Run Script**.
diff --git a/ydb/docs/ru/core/getting_started/_includes/yql/ui_embedded_prompt.md b/ydb/docs/ru/core/getting_started/_includes/yql/ui_embedded_prompt.md
index 41c8e83fbb..78fe78c92b 100644
--- a/ydb/docs/ru/core/getting_started/_includes/yql/ui_embedded_prompt.md
+++ b/ydb/docs/ru/core/getting_started/_includes/yql/ui_embedded_prompt.md
@@ -1 +1 @@
-- [Встроенный Web-интерфейс](#embedded)
+* [Встроенный Web-интерфейс](#embedded)
diff --git a/ydb/docs/ru/core/getting_started/_includes/yql/ui_embedded_scheme_ls.md b/ydb/docs/ru/core/getting_started/_includes/yql/ui_embedded_scheme_ls.md
index 5f9689c441..b81dcbdf01 100644
--- a/ydb/docs/ru/core/getting_started/_includes/yql/ui_embedded_scheme_ls.md
+++ b/ydb/docs/ru/core/getting_started/_includes/yql/ui_embedded_scheme_ls.md
@@ -1 +1 @@
-Во встроенном web-интерфейсе YDB перечень таблиц показывается в левой части страницы базы данных, в виде иерархии. На закладке **Info** показывается детальная информация по выбранному в иерархии объекту. \ No newline at end of file
+Во встроенном web-интерфейсе YDB перечень таблиц показывается в левой части страницы базы данных в виде иерархии. На закладке **Info** показывается детальная информация по выбранному в иерархии объекту.
diff --git a/ydb/docs/ru/core/getting_started/_includes/yql/ui_execute.md b/ydb/docs/ru/core/getting_started/_includes/yql/ui_execute.md
index 16e7f9d06c..255f9ad5ae 100644
--- a/ydb/docs/ru/core/getting_started/_includes/yql/ui_execute.md
+++ b/ydb/docs/ru/core/getting_started/_includes/yql/ui_execute.md
@@ -1,2 +1 @@
-
-{% include [ui_embedded_execute.md](ui_embedded_execute.md) %} \ No newline at end of file
+{% include [ui_embedded_execute.md](ui_embedded_execute.md) %}
diff --git a/ydb/docs/ru/core/getting_started/_includes/yql/ui_prompt.md b/ydb/docs/ru/core/getting_started/_includes/yql/ui_prompt.md
index 9550e1b18f..8676922f24 100644
--- a/ydb/docs/ru/core/getting_started/_includes/yql/ui_prompt.md
+++ b/ydb/docs/ru/core/getting_started/_includes/yql/ui_prompt.md
@@ -1,2 +1 @@
-
-{% include [ui_embedded_prompt.md](ui_embedded_prompt.md) %} \ No newline at end of file
+{% include [ui_embedded_prompt.md](ui_embedded_prompt.md) %}
diff --git a/ydb/docs/ru/core/getting_started/ydb_local.md b/ydb/docs/ru/core/getting_started/ydb_local.md
index 016595f7f5..91cbd1193b 100644
--- a/ydb/docs/ru/core/getting_started/ydb_local.md
+++ b/ydb/docs/ru/core/getting_started/ydb_local.md
@@ -20,9 +20,10 @@ export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:`pwd`/lib"
## Подготовьте конфигурацию локального кластера {#prepare-configuration}
-Подготовьте конфигурацию локального кластера, которую хотите развернуть. Для того, чтобы поднять кластер с хранением данных в памяти достаточно скопировать конфигурацию. Для разворачивания кластера с хранением данных в файле, необходимо дополнительно создать файл для хранения данных размером 64GB и указать путь до него в конфигурации.
+Подготовьте конфигурацию локального кластера, которую хотите развернуть. Для того, чтобы поднять кластер с хранением данных в памяти достаточно скопировать конфигурацию. Для разворачивания кластера с хранением данных в файле, необходимо дополнительно создать файл для хранения данных размером 64 ГБ и указать путь до него в конфигурации.
{% list tabs %}
+
- В памяти
```bash
@@ -81,7 +82,6 @@ export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:`pwd`/lib"
./bin/ydbd server --yaml-config ./config.yaml --tenant /Root/test --node-broker localhost:2135 --grpc-port 31001 --ic-port 31003 --mon-port 31002
```
-
## Работа с базой данных через Web UI {#web-ui}
Чтобы посмотреть на структуру базы данных и выполнить YQL-запрос, воспользуйтесь встроенным в процесс `ydbd` веб-интерфейсом. Для этого откройте браузер и перейдите по адресу `http://localhost:8765`. Подробней возможности встроенного веб-интерфейса описаны в разделе [Embedded UI](../maintenance/embedded_monitoring/ydb_monitoring.md).