aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authoralexv-smirnov <alexv-smirnov@yandex-team.ru>2022-02-24 01:54:54 +0300
committeralexv-smirnov <alexv-smirnov@yandex-team.ru>2022-02-24 01:54:54 +0300
commitae944dbe1a985556fe224f49a2b1ea85147a07fe (patch)
tree8a6830a18a3098b2acb3e57c4a2bc5da92160151
parent5d925f9be85e790a2b6e08f20400732b72761024 (diff)
downloadydb-ae944dbe1a985556fe224f49a2b1ea85147a07fe.tar.gz
ydb docs getting started yql embedded ui
ref:48b6cc9662a6f3220e55db05af197dfd50b1088c
-rw-r--r--ydb/docs/ru/core/getting_started/_assets/embedded_query.pngbin0 -> 291486 bytes
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/ydb_docker/03_start.md4
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/yql.md7
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/yql/ui_embedded_execute.md9
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/yql/ui_embedded_prompt.md1
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/yql/ui_embedded_scheme_ls.md1
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/yql/ui_execute.md2
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/yql/ui_prompt.md2
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/yql/ui_scheme_ls.md1
-rw-r--r--ydb/docs/ru/core/reference/ydb-sdk/example/go/_includes/run_custom.md2
-rw-r--r--ydb/docs/ru/core/reference/ydb-sdk/example/python/_includes/run_custom.md4
11 files changed, 25 insertions, 8 deletions
diff --git a/ydb/docs/ru/core/getting_started/_assets/embedded_query.png b/ydb/docs/ru/core/getting_started/_assets/embedded_query.png
new file mode 100644
index 0000000000..7b79eacbe1
--- /dev/null
+++ b/ydb/docs/ru/core/getting_started/_assets/embedded_query.png
Binary files differ
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 b35b0ec5f8..9a11fb56da 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 \
diff --git a/ydb/docs/ru/core/getting_started/_includes/yql.md b/ydb/docs/ru/core/getting_started/_includes/yql.md
index e1ac925652..ac040866e7 100644
--- a/ydb/docs/ru/core/getting_started/_includes/yql.md
+++ b/ydb/docs/ru/core/getting_started/_includes/yql.md
@@ -9,6 +9,7 @@ YQL - язык запросов к базе данных {{ ydb-short-name }},
{% include [yql/ui_prompt.md](yql/ui_prompt.md) %}
- [{{ ydb-short-name }} CLI](#cli)
+
- [{{ ydb-short-name }} SDK](../sdk.md)
Полная информация по синтаксису YQL находится в [справочнике по YQL](../../yql/reference/index.md).
@@ -26,10 +27,10 @@ YQL - язык запросов к базе данных {{ ydb-short-name }},
- Определить и проверить [параметры соединения с БД](../cli#scheme-ls)
- [Создать профиль `db1`](../cli.md#profile), настроенный на соединение с вашей БД.
-Текст приведенных ниже скриптов нужно сохранить в файл. Назовите его `script.yql`, чтобы команды в примерах можно было выполнить простым копированием через буфер обмена. Далее выполните команду `scripting yql` с указанием использования профиля `db1` и чтения скрипта из файла `script.yql`:
+Текст приведенных ниже скриптов нужно сохранить в файл. Назовите его `script.yql`, чтобы команды в примерах можно было выполнить простым копированием через буфер обмена. Далее выполните команду `{{ ydb-cli }} yql` с указанием использования профиля `db1` и чтения скрипта из файла `script.yql`:
``` bash
-{{ ydb-cli }} --profile db1 scripting yql -f script.yql
+{{ ydb-cli }} --profile db1 yql -f script.yql
```
## Работа со схемой данных {#ddl}
@@ -181,7 +182,7 @@ WHERE sa.series_id = $seriesId AND sa.season_id = $seasonId;
Для выполнения параметризованной выборки убедитесь, что выполнены предварительные требования пункта ["Исполнение в {{ ydb-short-name }} CLI"](#cli) данной статьи, и выполните следующую команду:
``` bash
-$ {{ ydb-cli }} --profile db1 scripting yql -f script.yql -p '$seriesId=1' -p '$seasonId=1'
+$ {{ ydb-cli }} --profile db1 yql -f script.yql -p '$seriesId=1' -p '$seasonId=1'
```
Полное описание возможностей передачи параметров находится в [справочнике по {{ ydb-short-name }} CLI](../../reference/ydb-cli/index.md).
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
new file mode 100644
index 0000000000..0b04c41af1
--- /dev/null
+++ b/ydb/docs/ru/core/getting_started/_includes/yql/ui_embedded_execute.md
@@ -0,0 +1,9 @@
+## Исполнение YQL во встроенном web-интерфейсе YDB {#embedded}
+
+Для выполнения запросов и скриптов YQL на самостоятельно развернутых базах данных YDB можно использовать [встроенный web-интерфейс YDB](../../../maintenance/embedded_monitoring/overview.md). При локальной установке с [использованием Docker](../../ydb_docker.md) с параметрами по умолчанию он доступен на [http://localhost:8765](http://localhost:8765).
+
+Выберите пункт **Databases** в меню слева, кликните на базе данных в списке, переключитесь на закладку **Query**:
+
+![embedded_query](../../_assets/embedded_query.png)
+
+Для выполнения YQL-скрипта нажмите кнопку **Run Script**. \ No newline at end of file
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
new file mode 100644
index 0000000000..41c8e83fbb
--- /dev/null
+++ b/ydb/docs/ru/core/getting_started/_includes/yql/ui_embedded_prompt.md
@@ -0,0 +1 @@
+- [Встроенный 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
new file mode 100644
index 0000000000..5f9689c441
--- /dev/null
+++ b/ydb/docs/ru/core/getting_started/_includes/yql/ui_embedded_scheme_ls.md
@@ -0,0 +1 @@
+Во встроенном web-интерфейсе YDB перечень таблиц показывается в левой части страницы базы данных, в виде иерархии. На закладке **Info** показывается детальная информация по выбранному в иерархии объекту. \ No newline at end of file
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 e69de29bb2..16e7f9d06c 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
@@ -0,0 +1,2 @@
+
+{% include [ui_embedded_execute.md](ui_embedded_execute.md) %} \ No newline at end of file
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 e69de29bb2..9550e1b18f 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
@@ -0,0 +1,2 @@
+
+{% include [ui_embedded_prompt.md](ui_embedded_prompt.md) %} \ No newline at end of file
diff --git a/ydb/docs/ru/core/getting_started/_includes/yql/ui_scheme_ls.md b/ydb/docs/ru/core/getting_started/_includes/yql/ui_scheme_ls.md
index e69de29bb2..b1d3988cc8 100644
--- a/ydb/docs/ru/core/getting_started/_includes/yql/ui_scheme_ls.md
+++ b/ydb/docs/ru/core/getting_started/_includes/yql/ui_scheme_ls.md
@@ -0,0 +1 @@
+{% include [ui_embedded_scheme_ls.md](ui_embedded_scheme_ls.md) %}
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 b2fddd2503..ec6dd455e5 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
@@ -13,7 +13,7 @@ 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_var`> - [Переменная окружения](../../../auth.md#env), определяющая режим аутентификации
- `<auth_mode_value>` - Значение параметра аутентификации для выбранного режима
Например:
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 5eda5743b4..c706ba6ada 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
@@ -13,12 +13,12 @@ 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_var`> - [Переменная окружения](../../../auth.md#env), определяющая режим аутентификации
- `<auth_mode_value>` - Значение параметра аутентификации для выбранного режима
Например:
``` bash
-( export YDB_ACCESS_TOKEN_CREDENTIALS="t1.9euelZqOnJuJlc..." && \
+YDB_ACCESS_TOKEN_CREDENTIALS="t1.9euelZqOnJuJlc..." \
python3 ydb-python-sdk/examples/basic_example_v1/ -e grpcs://ydb.example.com:2135 -d /path/db )
```