summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorbazeltsev <[email protected]>2022-06-26 23:00:46 +0300
committerbazeltsev <[email protected]>2022-06-26 23:00:46 +0300
commit9bc75c095b7cb5e9469b2cf87d2922a4f4672f99 (patch)
treec9b98e5a322cb2e9fdf939bb70ef90cb2d764f27
parent94c52cc42e173cefd0a5f4f8f7c49a63ed16a33e (diff)
Fix db path
fixed ref:3580991a344bbc79fa03ce392c87d7bc531ae0cc
-rw-r--r--ydb/docs/ru/core/concepts/_includes/connect.md8
-rw-r--r--ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_docker/01_intro.md4
-rw-r--r--ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_docker/04_request.md2
-rw-r--r--ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_local.md4
-rw-r--r--ydb/docs/ru/core/reference/ydb-cli/_includes/connect.md10
-rw-r--r--ydb/docs/ru/core/reference/ydb-cli/commands/_includes/dir.md2
-rw-r--r--ydb/docs/ru/core/reference/ydb-sdk/example/go/_includes/run_custom.md11
-rw-r--r--ydb/docs/ru/core/reference/ydb-sdk/example/java/_includes/run_custom.md11
-rw-r--r--ydb/docs/ru/core/reference/ydb-sdk/example/python/_includes/run_custom.md10
9 files changed, 32 insertions, 30 deletions
diff --git a/ydb/docs/ru/core/concepts/_includes/connect.md b/ydb/docs/ru/core/concepts/_includes/connect.md
index 11b7f2ab6dd..45fcc4bde55 100644
--- a/ydb/docs/ru/core/concepts/_includes/connect.md
+++ b/ydb/docs/ru/core/concepts/_includes/connect.md
@@ -6,7 +6,7 @@
1. Эндпоинт.
1. Аутентификационная информация.
-1. Размещение базы данных.
+1. Путь базы данных.
## Эндпоинт {#endpoint}
@@ -60,11 +60,11 @@
При использовании режимов, предусматривающих обращение клиента {{ ydb-short-name }} к IAM, дополнительно может быть задан URL IAM, предоставляющий API выдачи токенов. По умолчанию в существующих SDK и CLI производится попытка обращения к API IAM {{ yandex-cloud }}, размещенному на `iam.api.cloud.yandex.net:443`.
-## Размещение базы данных {#database}
+## Путь базы данных {#database}
-Размещение базы данных (`database`) - строка, определяющая где на кластере {{ ydb-short-name }} находится база данных, к которой адресован запрос. Имеет структуру [пути к файлу]{% if lang == "en" %}(https://en.wikipedia.org/wiki/Path_(computing)){% endif %}{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Путь_к_файлу){% endif %}, с использованием символа `/` в качестве разделителя. Начинается всегда с символа `/`.
+Путь базы данных (`database`) - строка, определяющая где на кластере {{ ydb-short-name }} находится база данных, к которой адресован запрос. Имеет структуру [пути к файлу]{% if lang == "en" %}(https://en.wikipedia.org/wiki/Path_(computing)){% endif %}{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Путь_к_файлу){% endif %}, с использованием символа `/` в качестве разделителя. Начинается всегда с символа `/`.
-На кластере {{ ydb-short-name }} может быть развернуто множество баз данных, и их размещение определяется конфигурацией кластера. Как и эндпоинт, для облачных баз данных `database` показывается в консоли управления на странице требуемой БД, а также обычно может быть получено через CLI облачного поставщика.
+На кластере {{ ydb-short-name }} может быть развернуто множество баз данных, и их пути определяются конфигурацией кластера. Как и эндпоинт, для облачных баз данных `database` показывается в консоли управления на странице требуемой БД, а также обычно может быть получен через CLI облачного поставщика.
При использовании облачных решений базы данных на кластере {{ ydb-short-name }} создаются и размещаются в режиме самообслуживания, не требуя участия владельца и администраторов кластера.
diff --git a/ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_docker/01_intro.md b/ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_docker/01_intro.md
index 152d5dbcd16..0448289c857 100644
--- a/ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_docker/01_intro.md
+++ b/ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_docker/01_intro.md
@@ -11,13 +11,13 @@
- gRPC
- [Эндпоинт](../../../../concepts/connect.md#endpoint): `grpc://localhost:2136`
- - [Размещение базы данных](../../../../concepts/connect.md#database): `/local`
+ - [Путь базы данных](../../../../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#database): `/local`
- [Аутентификация](../../../../concepts/connect.md#auth-modes): Анонимная (без аутентификации)
{% endlist %}
diff --git a/ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_docker/04_request.md b/ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_docker/04_request.md
index 6fa40f08808..3e65f16f661 100644
--- a/ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_docker/04_request.md
+++ b/ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_docker/04_request.md
@@ -1,6 +1,6 @@
## Выполнение запросов {#request}
-Установите YDB CLI и выполните запросы, как описано в статье [YDB CLI - Начало работы](../../../cli.md), используя эндпоинт и размещение базы данных в начале данной статьи, например:
+Установите YDB CLI и выполните запросы, как описано в статье [YDB CLI - Начало работы](../../../cli.md), используя эндпоинт и путь базы данных в начале данной статьи, например:
```bash
ydb -e grpc://localhost:2136 -d /local scheme ls
diff --git a/ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_local.md b/ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_local.md
index c1ce258ed88..adf56bbd5a8 100644
--- a/ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_local.md
+++ b/ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_local.md
@@ -7,7 +7,7 @@
В результате исполнения описанных ниже шагов вы получите запущенную на локальной машине базу данных YDB, с которой можно соединиться по следующим реквизитам:
- [Эндпоинт](../../../concepts/connect.md#endpoint): `grpc://localhost:2136`
-- [Размещение базы данных](../../../concepts/connect.md#database): `/Root/test`
+- [Путь базы данных](../../../concepts/connect.md#database): `/Root/test`
- [Аутентификация](../../../concepts/connect.md#auth-modes): Анонимная (без аутентификации)
## Установка {#install}
@@ -62,7 +62,7 @@ curl https://binaries.ydb.tech/local_scripts/install.sh | bash
## Выполнение запросов через YDB CLI {#cli}
-[Установите YDB CLI](../../../reference/ydb-cli/install.md) и выполнить запросы, как описано в статье [YDB CLI - Начало работы](../../cli.md), используя эндпоинт и размещение базы данных в [начале данной статьи](#conn), например:
+[Установите YDB CLI](../../../reference/ydb-cli/install.md) и выполнить запросы, как описано в статье [YDB CLI - Начало работы](../../cli.md), используя эндпоинт и путь базы данных в [начале данной статьи](#conn), например:
```bash
ydb -e grpc://localhost:2136 -d /Root/test scheme ls
diff --git a/ydb/docs/ru/core/reference/ydb-cli/_includes/connect.md b/ydb/docs/ru/core/reference/ydb-cli/_includes/connect.md
index feb858f85c4..ccae8c378e6 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/_includes/connect.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/_includes/connect.md
@@ -9,7 +9,7 @@
3. Переменных окружения
4. Активированного профиля
-Для того чтобы {{ ydb-short-name }} CLI попробовал соединиться с БД, в результате исполнения данных шагов должен быть определен [Эндпоинт](../../../concepts/connect.md#endpoint) и [Размещение базы данных](../../../concepts/connect.md#database).
+Для того чтобы {{ ydb-short-name }} CLI попробовал соединиться с БД, в результате исполнения данных шагов должен быть определен [эндпоинт](../../../concepts/connect.md#endpoint) и [путь базы данных](../../../concepts/connect.md#database).
Если все шаги пройдены, но {{ ydb-short-name }} CLI не определил режим аутентификации, то запросы будут отправляться на сервер {{ ydb-short-name }} без добавления аутентификационных данных. Это может позволить успешно работать с локально развернутыми кластерами {{ ydb-short-name }}, не требующими аутентификации. Для всех доступных по сети баз данных такие запросы будут отклонены сервером с выдачей ошибки аутентификации.
@@ -23,8 +23,8 @@
{{ ydb-cli }} <опции_соединения> <команда> <опции_команды>
```
-- `-e, --endpoint <endpoint>` : [Эндпоинт](../../../concepts/connect.md#endpoint) - основной параметр соединения, позволяющий найти сервер {{ ydb-short-name }} в сети. Если порт не указан, применяется 2135. Если протокол не указан, то в публичных сборках {{ ydb-short-name }} CLI применяется gRPCs (с шифрованием).
-- `-d, --database <database>` : [Размещение базы данных](../../../concepts/connect.md#database)
+- `-e, --endpoint <endpoint>` — [эндпоинт](../../../concepts/connect.md#endpoint) - основной параметр соединения, позволяющий найти сервер {{ ydb-short-name }} в сети. Если порт не указан, применяется 2135. Если протокол не указан, то в публичных сборках {{ ydb-short-name }} CLI применяется gRPCs (с шифрованием).
+- `-d, --database <database>` — [путь базы данных](../../../concepts/connect.md#database).
{% include [auth/options.md](auth/options.md) %}
@@ -48,9 +48,9 @@
### Ошибки до попытки установки соединения с БД
-Если все шаги из приведенных в начале данной статьи пройдены, но не удалось определить [Эндпоинт](../../../concepts/connect.md#endpoint), то выполнение команды будет прервано с выдачей сообщения `Missing required option 'endpoint'`.
+Если все шаги из приведенных в начале данной статьи пройдены, но не удалось определить [эндпоинт](../../../concepts/connect.md#endpoint), то выполнение команды будет прервано с выдачей сообщения `Missing required option 'endpoint'`.
-Если все шаги из приведенных в начале данной статьи пройдены, но не удалось определить [Размещение базы данных](../../../concepts/connect.md#database), то выполнение команды будет прервано с выдачей сообщения `Missing required option 'database'`.
+Если все шаги из приведенных в начале данной статьи пройдены, но не удалось определить [путь базы данных](../../../concepts/connect.md#database), то выполнение команды будет прервано с выдачей сообщения `Missing required option 'database'`.
Если режим аутентификации определить удалось, но не удалось определить необходимые дополнительные параметры, то выполнение команды будет прервано с выдачей сообщения, описывающего проблему:
diff --git a/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/dir.md b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/dir.md
index 045c9d7cb17..d01e9a7b5ec 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/dir.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/dir.md
@@ -25,7 +25,7 @@ Issues:
pathId: [OwnerId: <some>, LocalPathId: <some>], path type: EPathTypeDir, path state: EPathStateNoChanges
```
-Также поддерживается синтаксис указания полного пути, начинающегося с символа `/`, который должен в этом случае содержать в начале [размещение базы данных](../../../../concepts/connect.md#database), указанной в параметрах соединения, или с которой разрешаются операции через установленное соединение с кластером.
+Также поддерживается синтаксис указания полного пути, начинающегося с символа `/`, который должен в этом случае содержать в начале [путь базы данных](../../../../concepts/connect.md#database), указанной в параметрах соединения, или с которой разрешаются операции через установленное соединение с кластером.
Примеры:
diff --git a/ydb/docs/ru/core/reference/ydb-sdk/example/go/_includes/run_custom.md b/ydb/docs/ru/core/reference/ydb-sdk/example/go/_includes/run_custom.md
index ec6dd455e50..bd254cb43fd 100644
--- a/ydb/docs/ru/core/reference/ydb-sdk/example/go/_includes/run_custom.md
+++ b/ydb/docs/ru/core/reference/ydb-sdk/example/go/_includes/run_custom.md
@@ -1,4 +1,4 @@
-Для выполнения примера с использованием любой доступной базы данных YDB вам потребуется знать [Эндпоинт](../../../../../concepts/connect.md#endpoint) и [Размещение базы данных](../../../../../concepts/connect.md#database).
+Для выполнения примера с использованием любой доступной базы данных YDB вам потребуется знать [эндпоинт](../../../../../concepts/connect.md#endpoint) и [путь базы данных](../../../../../concepts/connect.md#database).
Если в базе данных включена аутентификация, то вам также понадобится выбрать [режим аутентификации](../../../../../concepts/connect.md#auth-modes) и получить секреты - токен или логин/пароль.
@@ -11,12 +11,13 @@ go run ./basic -ydb="<endpoint>?database=<database>" )
, где
-- `<endpoint>` - [Эндпоинт](../../../../../concepts/connect.md#endpoint)
-- `<database>` - [Размещение базы данных](../../../../../concepts/connect.md#database)
-- `<auth_mode_var`> - [Переменная окружения](../../../auth.md#env), определяющая режим аутентификации
-- `<auth_mode_value>` - Значение параметра аутентификации для выбранного режима
+- `<endpoint>` - [эндпоинт](../../../../../concepts/connect.md#endpoint).
+- `<database>` - [путь базы данных](../../../../../concepts/connect.md#database).
+- `<auth_mode_var`> - [переменная окружения](../../../auth.md#env), определяющая режим аутентификации.
+- `<auth_mode_value>` - значение параметра аутентификации для выбранного режима.
Например:
+
``` bash
( export YDB_ACCESS_TOKEN_CREDENTIALS="t1.9euelZqOnJuJlc..." && cd ydb-go-examples && \
go run ./basic -ydb="grpcs://ydb.example.com:2135?database=/somepath/somelocation" )
diff --git a/ydb/docs/ru/core/reference/ydb-sdk/example/java/_includes/run_custom.md b/ydb/docs/ru/core/reference/ydb-sdk/example/java/_includes/run_custom.md
index 6b1ad8eeeef..26b44ddf2db 100644
--- a/ydb/docs/ru/core/reference/ydb-sdk/example/java/_includes/run_custom.md
+++ b/ydb/docs/ru/core/reference/ydb-sdk/example/java/_includes/run_custom.md
@@ -1,4 +1,4 @@
-Для выполнения примера с использованием любой доступной базы данных YDB вам потребуется знать [Эндпоинт](../../../../../concepts/connect.md#endpoint) и [Размещение базы данных](../../../../../concepts/connect.md#database).
+Для выполнения примера с использованием любой доступной базы данных YDB вам потребуется знать [эндпоинт](../../../../../concepts/connect.md#endpoint) и [путь базы данных](../../../../../concepts/connect.md#database).
Если в базе данных включена аутентификация, то вам также понадобится выбрать [режим аутентификации](../../../../../concepts/connect.md#auth-modes) и получить секреты - токен или логин/пароль.
@@ -11,12 +11,13 @@
, где
-- `<endpoint>` - [Эндпоинт](../../../../../concepts/connect.md#endpoint)
-- `<database>` - [Размещение базы данных](../../../../../concepts/connect.md#database)
-- `<auth_mode_var`> - [Переменная окружения](../../../auth.md#env), определяющая режим аутентификации
-- `<auth_mode_value>` - Значение параметра аутентификации для выбранного режима
+- `<endpoint>` - [эндпоинт](../../../../../concepts/connect.md#endpoint).
+- `<database>` - [путь базы данных](../../../../../concepts/connect.md#database).
+- `<auth_mode_var`> - [переменная окружения](../../../auth.md#env), определяющая режим аутентификации.
+- `<auth_mode_value>` - значение параметра аутентификации для выбранного режима.
Например:
+
``` bash
YDB_ACCESS_TOKEN_CREDENTIALS="t1.9euelZqOnJuJlc..." java -jar examples/basic_example/target/ydb-basic-example.jar grpcs://ydb.example.com:2135?database=/somepath/somelocation
```
diff --git a/ydb/docs/ru/core/reference/ydb-sdk/example/python/_includes/run_custom.md b/ydb/docs/ru/core/reference/ydb-sdk/example/python/_includes/run_custom.md
index c706ba6ada1..b592d46ad1f 100644
--- a/ydb/docs/ru/core/reference/ydb-sdk/example/python/_includes/run_custom.md
+++ b/ydb/docs/ru/core/reference/ydb-sdk/example/python/_includes/run_custom.md
@@ -1,4 +1,4 @@
-Для выполнения примера с использованием любой доступной базы данных YDB вам потребуется знать [Эндпоинт](../../../../../concepts/connect.md#endpoint) и [Размещение базы данных](../../../../../concepts/connect.md#database).
+Для выполнения примера с использованием любой доступной базы данных YDB вам потребуется знать [эндпоинт](../../../../../concepts/connect.md#endpoint) и [путь базы данных](../../../../../concepts/connect.md#database).
Если в базе данных включена аутентификация, то вам также понадобится выбрать [режим аутентификации](../../../../../concepts/connect.md#auth-modes) и получить секреты - токен или логин/пароль.
@@ -11,10 +11,10 @@ python3 ydb-python-sdk/examples/basic_example_v1/ -e <endpoint> -d <database>
, где
-- `<endpoint>` - [Эндпоинт](../../../../../concepts/connect.md#endpoint)
-- `<database>` - [Размещение базы данных](../../../../../concepts/connect.md#database)
-- `<auth_mode_var`> - [Переменная окружения](../../../auth.md#env), определяющая режим аутентификации
-- `<auth_mode_value>` - Значение параметра аутентификации для выбранного режима
+- `<endpoint>` - [эндпоинт](../../../../../concepts/connect.md#endpoint).
+- `<database>` - [путь базы данных](../../../../../concepts/connect.md#database).
+- `<auth_mode_var`> - [переменная окружения](../../../auth.md#env), определяющая режим аутентификации.
+- `<auth_mode_value>` - значение параметра аутентификации для выбранного режима.
Например:
``` bash