Connecting via an IDE

Yandex Query supports JDBC (Java DataBase Connectivity) connections. It allows you to use JDBC-compatible IDEs, e.g., DBeaver and DataGrip, to work with Query connections.

While this tutorial describes connecting via DBeaver, the process is the same for any system that supports JDBC data sources.

DBeaverDBeaver

DBeaver is a free, cross-platform, open-source database management tool providing an intuitive interface for connecting to databases and running SQL queries. It supports multiple databases, including MySQL, PostgreSQL, SQLite, and Oracle.

JDBC driverJDBC driver

Connecting to Yandex Query from DBeaver requires a JDBC driver. Since Yandex Query is based on YDB federated queries, the connection needs a YDB JDBC driver.

To download the driver, do the following:

1. Navigate to the ydb-jdbc-driver repository.
2. Select the latest release tagged Latest and download ydb-jdbc-driver-shaded-<driver-version>.jar.

Registering a JDBC driver with DBeaverRegistering a JDBC driver with DBeaver

To register the JDBC driver, follow these steps:

1. Select Database from the DBeaver top menu and click Driver management:

   

2. To create a new driver, click New in the Driver Manager window:

   

3. In the Create driver window that opens, set Driver name to Yandex Query:

   

4. Navigate to the Libraries section, click Add file, specify the path to the YDB JDBC driver you downloaded previously, and click OK:

   

5. The Yandex Query driver will appear in the list. Double-click the driver name, switch to the Libraries tab, click Find Class, and select tech.ydb.jdbc.YdbDriver from the drop-down list.

   Warning

   Make sure you click tech.ydb.jdbc.YdbDriver in the drop-down list to select it. Otherwise, DBeaver will act as if you have not selected a driver.

   

Creating a Yandex Query connectionCreating a Yandex Query connection

Before creating a connection, complete the following steps:

1. Create a service account named dbeaver with the editor role.

2. Create an authorized key for the service account and save it to a file.

Then follow these steps:

1. In DBeaver, create a new connection with the Yandex Query connection type.

2. In the window that opens, navigate to the Main section.

3. Under General, specify the following path in the JDBC URL field:

   jdbc:ydb:grpcs://grpc.yandex-query.cloud.yandex.net:2135/<folder_id>?saFile=<path_to_auth_key_file.json>&useQueryService=false
   

   Where:

   • folder_id: ID of the folder you will use to run queries against Yandex Query.
   • path_to_auth_key_file.json: Authorized key file path.
   • useQueryService: Connection mode. Note that Yandex Query only supports the useQueryService=false mode.

   

4. Click Test connection ... to make sure your configuration is correct.

   If everything is correct, a success message will appear:

   

5. Click Finish to save the connection.

Working with Yandex QueryWorking with Yandex Query

In DBeaver, you can see the list of your data bindings and their structure:

Also, you can run queries: