diff --git a/ydb/docs/en/core/integrations/visualization/_assets/datalens.jpeg b/ydb/docs/en/core/integrations/visualization/_assets/datalens.jpeg new file mode 100644 index 000000000000..c841e4e7bc09 Binary files /dev/null and b/ydb/docs/en/core/integrations/visualization/_assets/datalens.jpeg differ diff --git a/ydb/docs/en/core/integrations/visualization/_includes/toc-table.md b/ydb/docs/en/core/integrations/visualization/_includes/toc-table.md index 4c66f46753c8..1aba3fb1057e 100644 --- a/ydb/docs/en/core/integrations/visualization/_includes/toc-table.md +++ b/ydb/docs/en/core/integrations/visualization/_includes/toc-table.md @@ -3,5 +3,6 @@ | Environment | Compatibility Level | Instruction | | --- | :---: | --- | | [Apache Superset](https://superset.apache.org) | [PostgreSQL wire protocol](../../../postgresql/intro.md) | [Instruction](../superset.md) | +| [DataLens](https://datalens.tech) | Full | [Instruction](../datalens.md) | | [FineBI](https://intl.finebi.com/) | [PostgreSQL wire protocol](../../../postgresql/intro.md) | [Instruction](../finebi.md) | -| [Grafana](https://grafana.com) | Full | [Instruction](../grafana.md) | \ No newline at end of file +| [Grafana](https://grafana.com) | Full | [Instruction](../grafana.md) | diff --git a/ydb/docs/en/core/integrations/visualization/datalens.md b/ydb/docs/en/core/integrations/visualization/datalens.md new file mode 100644 index 000000000000..c789ec78512e --- /dev/null +++ b/ydb/docs/en/core/integrations/visualization/datalens.md @@ -0,0 +1,58 @@ +# DataLens + +[DataLens](https://datalens.tech) is an open-source business intelligence (BI) and data visualization tool that enables users to analyze and display data from various sources, including {{ ydb-short-name }}. DataLens allows you to describe data models, create charts and other visualizations, build dashboards, and provide collaborative access to analytics. + +## Prerequisites + +DataLens must be [deployed and configured](https://datalens.tech/docs/en/quickstart.html). + +{% note info %} + +This article covers the integration of self-managed {{ ydb-short-name }} and DataLens. For documentation on integrating the respective managed services, refer to the [Yandex Cloud documentation](https://yandex.cloud/en/docs/datalens/operations/connection/create-ydb). + +{% endnote %} + +## Adding a database connection to {{ ydb-short-name }} {#add-database-connection} + +To create a connection to {{ ydb-short-name }}: + +1. Go to the [workbook](https://datalens.tech/docs/en/workbooks-collections/index.html) page or create a new one. +2. In the top right corner, click **Create** → **Connection**. +3. Select the **{{ ydb-short-name }}** connection. +4. Choose an authentication type: + + {% list tabs group=auth-type %} + + - Anonymous {#anonymous} + + * **Host name**. Specify the hostname for {{ ydb-short-name }} connection. + * **Port**. Specify the connection port for {{ ydb-short-name }}. The default port is 2135. + * **Database path**. Specify the name of the database to connect to. + + - Password {#password} + + * **Host name**. Specify the hostname for {{ ydb-short-name }} connection. + * **Port**. Specify the connection port for {{ ydb-short-name }}. The default port is 2135. + * **Database path**. Specify the name of the database to connect to. + * **Username**. Enter the username to connect to {{ ydb-short-name }}. + * **Password**. Enter the user password. + + - OAuth {#oauth} + + * **OAuth token**. Provide the OAuth token to access {{ ydb-short-name }}. + * **Host name**. Specify the hostname for {{ ydb-short-name }} connection. + * **Port**. Specify the connection port for {{ ydb-short-name }}. The default port is 2135. + * **Database path**. Specify the name of the database to connect to. + + {% endlist %} + + * **Cache lifetime in seconds**. Set the cache lifetime or leave the default value. The recommended value is 300 seconds (5 minutes). + * **SQL query access level**. Allows the use of custom SQL queries to create a dataset. + +5. Click **Create connection**. +6. Specify a connection name and click **Create**. +7. Proceed to [creating a dataset](https://datalens.tech/docs/en/dataset/index.html). + +## Example + +![DataLens {{ ydb-short-name }} connection](_assets/datalens.jpeg) \ No newline at end of file diff --git a/ydb/docs/en/core/integrations/visualization/toc-visualization.yaml b/ydb/docs/en/core/integrations/visualization/toc-visualization.yaml index 08cd20e34ad4..bff5b0cac653 100644 --- a/ydb/docs/en/core/integrations/visualization/toc-visualization.yaml +++ b/ydb/docs/en/core/integrations/visualization/toc-visualization.yaml @@ -1,6 +1,8 @@ items: - name: Apache Superset href: superset.md +- name: DataLens + href: datalens.md - name: FineBI href: finebi.md - name: Grafana data source diff --git a/ydb/docs/ru/core/integrations/visualization/_assets/datalens.jpeg b/ydb/docs/ru/core/integrations/visualization/_assets/datalens.jpeg new file mode 100644 index 000000000000..580828d8abff Binary files /dev/null and b/ydb/docs/ru/core/integrations/visualization/_assets/datalens.jpeg differ diff --git a/ydb/docs/ru/core/integrations/visualization/_includes/toc-table.md b/ydb/docs/ru/core/integrations/visualization/_includes/toc-table.md index 9a68e98cbd49..dc2a7a5046f1 100644 --- a/ydb/docs/ru/core/integrations/visualization/_includes/toc-table.md +++ b/ydb/docs/ru/core/integrations/visualization/_includes/toc-table.md @@ -3,5 +3,6 @@ | Среда | Уровень поддержки | Инструкция | | --- | :---: | --- | | [Apache Superset](https://superset.apache.org) | Через [PostgreSQL-совместимость](../../../postgresql/intro.md) | [Инструкция](../superset.md) | +| [DataLens](https://datalens.tech) | Полный | [Инструкция](../datalens.md) | | [FineBI](https://intl.finebi.com) | Через [PostgreSQL-совместимость](../../../postgresql/intro.md) | [Инструкция](../finebi.md) | | [Grafana](https://grafana.com) | Полный| [Инструкция](../grafana.md) | diff --git a/ydb/docs/ru/core/integrations/visualization/datalens.md b/ydb/docs/ru/core/integrations/visualization/datalens.md new file mode 100644 index 000000000000..bf531c122bc6 --- /dev/null +++ b/ydb/docs/ru/core/integrations/visualization/datalens.md @@ -0,0 +1,58 @@ +# DataLens + +[DataLens](https://datalens.tech) — инструмент бизнес-аналитики (BI) и визуализации данных с открытым исходным кодом, который позволяет анализировать и отображать данные из различных источников, включая {{ ydb-short-name }}. DataLens позволяет описывать модели данных, строить графики и визуализации, собирать дашборды и обеспечивать коллективный доступ к аналитике. + +## Предварительные требования + +DataLens должен быть [развёрнут и настроен](https://datalens.tech/docs/ru/quickstart.html). + +{% note info %} + +В этой статье рассматривается интеграция {{ ydb-short-name }} и DataLens, развёрнутых самостоятельно. Документацию по интеграции соответствующих управляемых сервисов см. в [документации Yandex Cloud](https://yandex.cloud/ru/docs/datalens/operations/connection/create-ydb). + +{% endnote %} + +## Добавление подключения к базе данных {{ ydb-short-name }} {#add-database-connection} + +Чтобы создать подключение к {{ ydb-short-name }}: + +1. Перейдите на страницу [воркбука](https://datalens.tech/docs/ru/workbooks-collections/index.html) или создайте новый. +2. В правом верхнем углу нажмите **Создать** → **Подключение**. +3. Выберите тип подключения **{{ ydb-short-name }}**. +4. Укажите тип аутентификации: + + {% list tabs group=auth-type %} + + - Анонимный {#anonymous} + + * **Имя хоста** — хостнейм для подключения к {{ ydb-short-name }}. + * **Порт** — порт подключения к {{ ydb-short-name }}. По умолчанию — 2135. + * **Путь к базе данных** — имя базы данных для подключения. + + - Пароль {#password} + + * **Имя хоста** — хостнейм для подключения к {{ ydb-short-name }}. + * **Порт** — порт подключения к {{ ydb-short-name }}. По умолчанию — 2135. + * **Путь к базе данных** — имя базы данных для подключения. + * **Имя пользователя** — имя пользователя для подключения к {{ ydb-short-name }}. + * **Пароль** — пароль пользователя. + + - OAuth {#oauth} + + * **OAuth-токен** — OAuth-токен для доступа к {{ ydb-short-name }}. + * **Имя хоста** — хостнейм для подключения к {{ ydb-short-name }}. + * **Порт** — порт подключения к {{ ydb-short-name }}. По умолчанию — 2135. + * **Путь к базе данных** — имя базы данных для подключения. + + {% endlist %} + + * **Время жизни кэша в секундах** — установите время жизни кэша или оставьте значение по умолчанию. Рекомендуемое значение — 300 секунд (5 минут). + * **Уровень доступа к SQL-запросам** — позволяет использовать собственные SQL-запросы для создания датасета. + +5. Нажмите **Создать подключение**. +6. Укажите имя подключения и нажмите **Создать**. +7. Перейдите к [созданию датасета](https://datalens.tech/docs/ru/dataset/index.html). + +## Пример + +![DataLens {{ ydb-short-name }} connection](_assets/datalens.jpeg) \ No newline at end of file diff --git a/ydb/docs/ru/core/integrations/visualization/toc-visualization.yaml b/ydb/docs/ru/core/integrations/visualization/toc-visualization.yaml index 08cd20e34ad4..bff5b0cac653 100644 --- a/ydb/docs/ru/core/integrations/visualization/toc-visualization.yaml +++ b/ydb/docs/ru/core/integrations/visualization/toc-visualization.yaml @@ -1,6 +1,8 @@ items: - name: Apache Superset href: superset.md +- name: DataLens + href: datalens.md - name: FineBI href: finebi.md - name: Grafana data source