Skip to content

Commit 62a3099

Browse files
vgvolegvgvoleg
authored
Add reference to YDB SQLAlchemy + Jupyter Notebook example (#12132)
1 parent 8e7d349 commit 62a3099

File tree

6 files changed

+46
-0
lines changed

6 files changed

+46
-0
lines changed

‎ydb/docs/en/core/integrations/gui/_includes/toc-table.md

+1
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@
77
| JetBrains Database viewer | — | By [JDBC-driver](https://github.com/ydb-platform/ydb-jdbc-driver/releases)|
88
| [JetBrains DataGrip](https://www.jetbrains.com/datagrip/) | [Instruction](../datagrip.md) | By [JDBC-driver](https://github.com/ydb-platform/ydb-jdbc-driver/releases)|
99
| Other JDBC-compatible IDEs | — | By [JDBC-driver](https://github.com/ydb-platform/ydb-jdbc-driver/releases)|
10+
| [Jupyter Notebook](https://jupyter.org) | [Instruction](../jupyter.md) | By [YDB-SQLAlchemy](https://github.com/ydb-platform/ydb-sqlalchemy/releases)|

‎ydb/docs/en/core/integrations/gui/jupyter.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Work with {{ ydb-short-name }} from Jupyter Notebook
2+
3+
[Jupyter Notebook](https://jupyter.org) is an open-source tool for creating shareable documents that combine code, plain language descriptions, data, rich visualizations, and interactive controls.
4+
5+
The [ydb-sqlalchemy dialect](https://github.com/ydb-platform/ydb-sqlalchemy/releases) enables working with {{ ydb-short-name }} from tools such as:
6+
7+
* [Pandas](https://pandas.pydata.org/)
8+
* [JupySQL](https://jupysql.ploomber.io/)
9+
10+
## Example
11+
12+
A detailed usage example is available as a [notebook](https://github.com/ydb-platform/ydb-sqlalchemy/blob/main/examples/jupyter_notebook/YDB%20SQLAlchemy%20%2B%20Jupyter%20Notebook%20Example.ipynb).
13+
14+
Prerequisites:
15+
16+
1. Python 3.8+
17+
2. [Jupyter Notebook](https://jupyter.org/install#jupyter-notebook)
18+
3. Existing {{ ydb-short-name }} cluster, a single-node one from [quickstart](../../quickstart.md) will suffice
19+
20+
To run the example, download the notebook file <!-- markdownlint-disable no-bare-urls -->{% file src="https://raw.githubusercontent.com/ydb-platform/ydb-sqlalchemy/refs/heads/main/examples/jupyter_notebook/YDB%20SQLAlchemy%20%2B%20Jupyter%20Notebook%20Example.ipynb" name="YDB SQLAlchemy - Jupyter Notebook Example.ipynb" %}, open it in Jupyter, and follow each cell sequentially, executing code as necessary.

‎ydb/docs/en/core/integrations/gui/toc-ide.yaml

+2
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,5 @@ items:
33
href: dbeaver.md
44
- name: DataGrip
55
href: datagrip.md
6+
- name: Jupyter Notebook
7+
href: jupyter.md

‎ydb/docs/ru/core/integrations/gui/_includes/toc-table.md

+1
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@
77
| JetBrains Database viewer | — | C помощью [JDBC-драйвера](https://github.com/ydb-platform/ydb-jdbc-driver/releases)|
88
| [JetBrains DataGrip](https://www.jetbrains.com/ru-ru/datagrip/) | [Инструкция](../datagrip.md) | C помощью [JDBC-драйвера](https://github.com/ydb-platform/ydb-jdbc-driver/releases)|
99
| Другие JDBC-совместимые IDE | — | C помощью [JDBC-драйвера](https://github.com/ydb-platform/ydb-jdbc-driver/releases)|
10+
| [Jupyter Notebook](https://jupyter.org) | [Инструкция](../jupyter.md) | С помощью [YDB-SQLAlchemy](https://github.com/ydb-platform/ydb-sqlalchemy/releases)|

‎ydb/docs/ru/core/integrations/gui/jupyter.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Работа с {{ ydb-short-name }} с помощью Jupyter Notebook
2+
3+
[Jupyter Notebook](https://jupyter.org) - это инструмент с открытым исходным кодом для создания общедоступных документов, сочетающий в себе код, описания на простом языке, данные, богатую визуализацию и интерактивные элементы управления.
4+
5+
[Диалект ydb-sqlalchemy](https://github.com/ydb-platform/ydb-sqlalchemy/releases) позволяет работать с {{ ydb-short-name }} напрямую из таких инструментов как:
6+
7+
* [Pandas](https://pandas.pydata.org/)
8+
* [JupySQL](https://jupysql.ploomber.io/)
9+
10+
## Пример
11+
12+
Подробный пример работы доступен в специальном [ноутбуке](https://github.com/ydb-platform/ydb-sqlalchemy/blob/main/examples/jupyter_notebook/YDB%20SQLAlchemy%20%2B%20Jupyter%20Notebook%20Example.ipynb).
13+
14+
Требования для запуска:
15+
16+
1. Python 3.8+
17+
2. [Jupyter Notebook](https://jupyter.org/install#jupyter-notebook)
18+
3. Существующий кластер {{ ydb-short-name }}, однонодовая инсталляция из [быстрого старта](../../quickstart.md) будет достаточной
19+
20+
Для запуска примера скачайте файл ноутбука <!-- markdownlint-disable no-bare-urls -->{% file src="https://raw.githubusercontent.com/ydb-platform/ydb-sqlalchemy/refs/heads/main/examples/jupyter_notebook/YDB%20SQLAlchemy%20%2B%20Jupyter%20Notebook%20Example.ipynb" name="YDB SQLAlchemy - Jupyter Notebook Example.ipynb" %}, откройте его в Jupyter и последовательно пройдитесь по каждой ячейке, выполняя код по мере необходимости.

‎ydb/docs/ru/core/integrations/gui/toc-ide.yaml

+2
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,5 @@ items:
33
href: dbeaver.md
44
- name: DataGrip
55
href: datagrip.md
6+
- name: Jupyter Notebook
7+
href: jupyter.md

0 commit comments

Comments
 (0)