Skip to content

Commit 487f050

Browse files
SloNNblinkov
andauthored
integrations en version (#7912)
Co-authored-by: Alex Dmitriev <[email protected]> Co-authored-by: Ivan Blinkov <[email protected]>
1 parent 30c09f9 commit 487f050

14 files changed

+142
-2
lines changed
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Connecting to {{ ydb-short-name }} with DBeaver
2+
3+
[DBeaver](https://dbeaver.com) is a free, cross-platform, open-source database management tool that provides a visual interface for connecting to various databases and executing SQL queries. It supports many database management systems, including MySQL, PostgreSQL, Oracle, and SQLite.
4+
5+
DBeaver allows you to work with {{ ydb-short-name }} using the Java DataBase Connectivity ([JDBC](https://en.wikipedia.org/wiki/Java_Database_Connectivity)) protocol. This article demonstrates how to set up this integration.
6+
7+
8+
### Connecting the {{ ydb-name }} JDBC Driver to DBeaver {#dbeaver_ydb}
9+
10+
11+
To connect to {{ ydb-name }} from DBeaver, you will need the JDBC driver. Follow these steps to download the JDBC driver:
12+
1. Go to the [ydb-jdbc-driver repository](https://github.com/ydb-platform/ydb-jdbc-driver/releases).
13+
1. Select the latest release (tagged as `Latest`) and save the `ydb-jdbc-driver-shaded-<driver-version>.jar` file.
14+
15+
Follow these steps to connect the downloaded JDBC driver:
16+
1. In the top menu of DBeaver, select the **Database** option, then select **Driver Manager**:
17+
![](./_assets/dbeaver-driver-management.png)
18+
19+
1. To create a new driver, click the **New** button in the **Driver Manager** window that opens
20+
![](./_assets/dbeaver-driver-create-new-driver.png)
21+
22+
1. In the **Create Driver** window that opens, specify `YDB` in the **Driver Name** field:
23+
24+
![](./_assets/dbeaver-driver-create-new-driver-set-name.png)
25+
26+
1. Go to the **Libraries** section, click **Add File**, specify the path to the previously downloaded {{ ydb-short-name }} JDBC driver (the `ydb-jdbc-driver-shaded-<driver-version>.jar` file), and click **OK**:
27+
28+
![](./_assets/dbeaver-driver-management-driver.png)
29+
30+
1. The **YDB** item will appear in the list of drivers. Double-click the new driver and go to the **Libraries** tab, click **Find Class**, and select `tech.ydb.jdbc.YdbDriver` from the dropdown list.
31+
32+
{% note warning %}
33+
34+
Be sure to explicitly select the `tech.ydb.jdbc.YdbDriver` item from the dropdown list by clicking on it. Otherwise, DBeaver will consider that the driver has not been selected.
35+
36+
{% endnote %}
37+
38+
![](./_assets/dbeaver-driver-management-driver_set.png)
39+
40+
### Creating a Connection to {{ ydb-name }} {#dbeaver_ydb_connection}
41+
42+
Perform the following steps to establish a connection:
43+
44+
1. In DBeaver, create a new connection, specifying the `YDB` connection type.
45+
1. In the window that opens, go to the **Main** section.
46+
1. In the **General** subsection, in the **JDBC URL** input field, specify the following connection string:
47+
48+
```
49+
jdbc:ydb:<ydb_endpoint>/<ydb_database>?useQueryService=true
50+
```
51+
52+
Where:
53+
- `ydb_endpoint` — the [endpoint](../../concepts/connect.md#endpoint) of the {{ydb-name}} cluster to which the connection will be made.
54+
- `ydb_database` — the path to the [database](../../concepts/glossary.md#database) in the {{ydb-name}} cluster to which queries will be made.
55+
56+
![](./_assets/dbeaver-ydb-connection.png)
57+
58+
1. In the **User** and **Password** fields, enter the login and password for connecting to the database. A complete list of authentication methods and connection strings for {{ ydb-name }} is provided in the [JDBC driver](https://github.com/ydb-platform/ydb-jdbc-driver) description.
59+
60+
1. Click **Test Connection...** to verify the settings.
61+
62+
If all settings are correct, a message indicating successful connection testing will appear:
63+
64+
![](./_assets/dbeaver-connection-test.png =400x)
65+
66+
1. Click **Finish** to save the connection.
67+
68+
69+
### Working with {{ ydb-name }} {#dbeaver_ydb_connection}
70+
71+
With DBeaver, you can view the list and structure of tables:
72+
73+
![](./_assets/dbeaver-table-structure.png)
74+
75+
As well as execute queries on the data:
76+
77+
![](./_assets/dbeaver-query.png)
+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Integrations {{ ydb-short-name }}
2+
3+
This section provides the main information about {{ ydb-name }} integrations with third-party systems.
4+
5+
{% note info %}
6+
7+
In addition to its own native protocol, {{ ydb-name }} has a compatibility layer that allows external systems to connect to databases via network protocols PostgreSQL or Apache Kafka. Due to the compatibility layer, many tools designed to work with these systems can also interact with {{ ydb-name }}. The compatibility level of each specific application needs to be clarified separately.
8+
9+
{% endnote %}
10+
11+
12+
## Graphical Interface Clients {#gui}
13+
14+
| Environment | Instruction | Compatibility Level |
15+
| --- | --- | --- |
16+
| Embedded UI | [Instruction](../reference/embedded-ui/index.md) | |
17+
| [DBeaver](https://dbeaver.com) | [Instruction](ide/dbeaver.md) | By [JDBC-driver](https://github.com/ydb-platform/ydb-jdbc-driver/releases)|
18+
| JetBrains Database viewer || By [JDBC-driver](https://github.com/ydb-platform/ydb-jdbc-driver/releases)|
19+
| [JetBrains DataGrip](https://www.jetbrains.com/datagrip/) || By [JDBC-driver](https://github.com/ydb-platform/ydb-jdbc-driver/releases)|
20+
| Other JDBC-compatible IDEs || By [JDBC-driver](https://github.com/ydb-platform/ydb-jdbc-driver/releases)|
21+
22+
23+
## Data Visualization (Business Intelligence, BI) {#bi}
24+
25+
| Environment | Compatibility Level | Instruction |
26+
| --- | :---: | --- |
27+
| [Grafana](https://grafana.com) | Full| [Instruction](grafana.md) |
28+
29+
30+
## Data Ingestion {#ingestion}
31+
32+
| Delivery System | Instruction |
33+
| --- | --- |
34+
| [FluentBit](https://fluentbit.io) | [Instruction](fluent-bit.md) |
35+
| [LogStash](https://www.elastic.co/logstash) | [Instruction](logstash.md) |
36+
| [Kafka Connect Sink](https://docs.confluent.io/platform/current/connect/index.html) | [Instruction](https://github.com/ydb-platform/ydb-kafka-sink-connector) |
37+
| Arbitrary [JDBC-источники данных](https://en.wikipedia.org/wiki/Java_Database_Connectivity) | [Instruction](import-jdbc.md) |
38+
39+
40+
### Streaming Data Ingestion {#streaming-ingestion}
41+
42+
| Delivery System | Instruction |
43+
| --- | --- |
44+
| [Apache Kafka API](https://kafka.apache.org) | [Instruction](../reference/kafka-api/index.md) |
45+
46+
47+
## Data Migrations {#schema_migration}
48+
49+
| Environment | Instruction |
50+
| --- | --- |
51+
| [goose](https://github.com/pressly/goose/) | [Instruction](goose.md) |
52+
| [Liquibase](https://www.liquibase.com) | [Instruction](liquibase.md) |
53+
| [Flyway](https://documentation.red-gate.com/fd/) | [Instruction](flyway.md) |
54+
| [Hibernate](https://hibernate.org/orm/) | [Instruction](hibernate.md) |
55+
56+
## See Also
57+
58+
* [{#T}](../reference/ydb-sdk/index.md)
59+
* [{#T}](../postgresql/intro.md)
60+
* [{#T}](../reference/kafka-api/index.md)

ydb/docs/en/core/integrations/toc_i.yaml

+2
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,5 @@ items:
1515
href: hibernate.md
1616
- name: Importing from JDBC data sources
1717
href: import-jdbc.md
18+
- name: DBeaver
19+
href: ide/dbeaver.md

ydb/docs/en/core/reference/toc_p.yaml

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
items:
22
- name: YQL
33
href: ../yql/reference/index.md
4-
include:
4+
include:
55
mode: link
66
path: ../yql/toc_p.yaml
77
- name: Compatibility with PostgreSQL
@@ -15,7 +15,8 @@ items:
1515
mode: link
1616
path: embedded-ui/toc_p.yaml
1717
- name: Integrations
18-
include:
18+
href: ../integrations/index.md
19+
include:
1920
mode: link
2021
path: ../integrations/toc_p.yaml
2122
- name: YDB CLI
Binary file not shown.

0 commit comments

Comments
 (0)