-
Notifications
You must be signed in to change notification settings - Fork 741
[docs] add DataLens integration #18129
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
|
|
||
|  | ||
2 changes: 2 additions & 0 deletions
2
ydb/docs/en/core/integrations/visualization/toc-visualization.yaml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -3,5 +3,6 @@ | |||||
| | Среда | Уровень поддержки | Инструкция | | ||||||
| | --- | :---: | --- | | ||||||
| | [Apache Superset](https://superset.apache.org) | Через [PostgreSQL-совместимость](../../../postgresql/intro.md) | [Инструкция](../superset.md) | | ||||||
| | [DataLens](https://datalens.tech) | Полный | [Instruction](../datalens.md) | | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| | [FineBI](https://intl.finebi.com) | Через [PostgreSQL-совместимость](../../../postgresql/intro.md) | [Инструкция](../finebi.md) | | ||||||
| | [Grafana](https://grafana.com) | Полный| [Инструкция](../grafana.md) | | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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). | ||
|
|
||
| ## Пример | ||
|
|
||
|  |
2 changes: 2 additions & 0 deletions
2
ydb/docs/ru/core/integrations/visualization/toc-visualization.yaml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.