diff options
author | alexv-smirnov <alexv-smirnov@yandex-team.ru> | 2022-02-24 15:03:10 +0300 |
---|---|---|
committer | alexv-smirnov <alexv-smirnov@yandex-team.ru> | 2022-02-24 15:03:10 +0300 |
commit | e593c74c608a3cd3ec6189c63ec44ed28616340e (patch) | |
tree | 18dd8758c13925da75fd5174d5e04f07ec676994 | |
parent | c3384969be667a3aeac80b33e3f0cee00877abd9 (diff) | |
download | ydb-e593c74c608a3cd3ec6189c63ec44ed28616340e.tar.gz |
ydb docs getting started embedded ui improved + added as option to yandex internal docs
ref:28eece4ca331d131c5c68ade3cc4ccec9ae5efa4
3 files changed, 32 insertions, 16 deletions
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 10032b2762..f307871a48 100644 --- a/ydb/docs/ru/core/getting_started/_includes/create_db.md +++ b/ydb/docs/ru/core/getting_started/_includes/create_db.md @@ -1,5 +1,7 @@ # Создание базы данных - Начало работы +Подробная информация о базах данных находится в статье [Термины и определения - База данных](../../concepts/databases.md#database) в разделе Концепции. + {% include [create_db_overlay.md](create_db_overlay.md) %} ## Самостоятельное развертывание {#self-hosted} @@ -10,8 +12,6 @@ * [В Kubernetes](../../deploy/orchestrated/concepts.md). * [Локально из скачанного исполняемого файла](../ydb_local.md). -Подробная информация о базах данных находится в статье [Термины и определения - База данных](../../concepts/databases.md#database) в разделе Концепции. - ## Продолжение знакомства с YDB {#next} После создания базы данных перейдите к статье [Аутентификация - Начало работы](../auth.md) для продолжения знакомства с YDB.
\ No newline at end of file diff --git a/ydb/docs/ru/core/getting_started/_includes/yql.md b/ydb/docs/ru/core/getting_started/_includes/yql.md index ac040866e7..0a872874a9 100644 --- a/ydb/docs/ru/core/getting_started/_includes/yql.md +++ b/ydb/docs/ru/core/getting_started/_includes/yql.md @@ -4,7 +4,15 @@ YQL - язык запросов к базе данных {{ ydb-short-name }}, диалект SQL. В частности, он обладает синтаксическими особенностями, рассчитанными на его применение при исполнении запросов на кластерах. -{{ ydb-short-name }} предоставляет следующие способы отправки запроса к базе данных на языке YQL: +Полная информация по синтаксису YQL находится в [справочнике по YQL](../../yql/reference/index.md). + +Приведенные ниже примеры формируют сценарий знакомства с YQL, и предполагают последовательное выполнение: запросы в разделе ["Работа с данными"](#dml) обращаются к данным в таблицах, созданным в разделе ["Работа со схемой данных"](#ddl). Выполняйте шаги последовательно, чтобы скопированные через буфер обмена примеры успешно исполнялись. + +Базовый интерфейс {{ ydb-short-name }} YQL принимает на вход не одну команду, а скрипт, который может состоять из множества команд. + +## Инструменты исполнения YQL {#tools} + +{{ ydb-short-name }} предоставляет следующие инструменты для отправки запроса к базе данных на языке YQL: {% include [yql/ui_prompt.md](yql/ui_prompt.md) %} @@ -12,15 +20,10 @@ YQL - язык запросов к базе данных {{ ydb-short-name }}, - [{{ ydb-short-name }} SDK](../sdk.md) -Полная информация по синтаксису YQL находится в [справочнике по YQL](../../yql/reference/index.md). - -Приведенные ниже примеры формируют сценарий знакомства с YQL, и предполагают последовательное выполнение: запросы в разделе ["Работа с данными"](#dml) обращаются к данным в таблицах, созданным в разделе ["Работа со схемой данных"](#ddl). Выполняйте шаги последовательно, чтобы скопированные через буфер обмена примеры успешно исполнялись. - -Базовый интерфейс {{ ydb-short-name }} YQL принимает на вход не одну команду, а скрипт, который может состоять из множества команд. {% include [yql/ui_execute.md](yql/ui_execute.md) %} -### Исполнение YQL в {{ ydb-short-name }} CLI {#cli} +### {{ ydb-short-name }} CLI {#cli} Для исполнения скриптов через {{ ydb-short-name }} CLI нужно предварительно: - Выполнить [установку CLI](../cli.md#install) @@ -73,9 +76,9 @@ CREATE TABLE episodes ( Описание всех возможностей работы с таблицами приведены в разделах документаци по YQL: -- [`CREATE TABLE`](../../yql/reference/syntax/create_table) - создание таблицы и определение начальных параметров -- [`ALTER TABLE`](../../yql/reference/syntax/alter_table) - изменение состава колонок таблицы и её параметров -- [`DROP TABLE`](../../yql/reference/syntax/drop_table) - удаление таблицы +- [`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) данной статьи. @@ -93,11 +96,11 @@ CREATE TABLE episodes ( ## Работа с данными {#dml} -{% include [yql/ui_dml_autocommit.md](yql/ui_dml_autocommit.md) %} +Команды исполнения YQL запросов и скриптов в YDB CLI и web-интерфейсе работают в режиме **Autocommit**, то есть после успешного исполнения транзакция подтверждается автоматически. ### UPSERT : Запись данных {#upsert} -Самым эффективным способом записи данных в {{ ydb-short-name }} является нестандартная для SQL [команда `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 }} поддерживают работу как с выборками, так и со множеством записей, передаваемых непосредственно с запросе. @@ -137,6 +140,13 @@ VALUES ``` Для исполнения скрипта через {{ 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) - добавлени записей/изменение указанных полей + ### SELECT : Выборка данных {#select} Запросите выборку записанных на предыдущем шаге данных: @@ -157,6 +167,12 @@ SELECT * FROM episodes; Для исполнения скрипта через {{ 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) - группировка данных при выполнении выборки + ### Параметризованные запросы {#param} Для транзакционных приложений, работающих с базой данных, характерно исполнение множества однотипных запросов, отличающихся только параметрами. Как и большинство баз данных, {{ ydb-short-name }} будет работать эффективнее, если вы определите изменяемые параметры и их типы, а далее будете инициировать исполнение запроса, передавая значения параметров отдельно от его текста. @@ -182,7 +198,7 @@ WHERE sa.series_id = $seriesId AND sa.season_id = $seasonId; Для выполнения параметризованной выборки убедитесь, что выполнены предварительные требования пункта ["Исполнение в {{ ydb-short-name }} CLI"](#cli) данной статьи, и выполните следующую команду: ``` bash -$ {{ ydb-cli }} --profile db1 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 index 0b04c41af1..26543ba2fe 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 @@ -1,4 +1,4 @@ -## Исполнение YQL во встроенном web-интерфейсе YDB {#embedded} +### Встроенный web-интерфейс YDB {#embedded} Для выполнения запросов и скриптов YQL на самостоятельно развернутых базах данных YDB можно использовать [встроенный web-интерфейс YDB](../../../maintenance/embedded_monitoring/overview.md). При локальной установке с [использованием Docker](../../ydb_docker.md) с параметрами по умолчанию он доступен на [http://localhost:8765](http://localhost:8765). |