MaxCompute:Connect DBeaver to MaxCompute

Prerequisites

Before you begin, ensure that you have:

• A MaxCompute project. See Create a MaxCompute project

• An AccessKey pair for your Alibaba Cloud account. See Create an AccessKey pair

• The MaxCompute JDBC driver JAR file (odps-jdbc-3.9.0-rc4-jar-with-dependencies.jar). Download it from one of the following sources:

  • Direct download (v3.9.0)

  • GitHub releases (latest version)

  • Maven repository (latest version)

• DBeaver Community Edition installed. Download it from dbeaver.io

Step 1: Configure the MaxCompute JDBC driver in DBeaver

DBeaver does not include a MaxCompute driver by default. Configure one using the SQLite generic driver as a template.

1. Launch DBeaver.

2. In the top menu bar, click to open the Select your database dialog box.

3. Select SQL > SQLite, then click Next to open the Generic JDBC Connection Settings dialog box.

4. On the Main tab, click Driver Settings to open the Edit Driver 'SQLite' dialog box.

5. On the Settings tab, set the following fields:

   Field	Value
   Class Name	Com.aliyun.odps.jdbc.odpsdriver
   URL Template	Jdbc:odps:{file}

   

6. On the Libraries tab, click Add File and select the odps-jdbc-3.9.0-rc4-jar-with-dependencies.jar file you downloaded.

   

7. Click OK.

Step 2: Connect to your MaxCompute project

1. In the Generic JDBC Connection Settings dialog box, go to the Main tab.

2. Set Connect by to URL.

3. In the JDBC URL field, enter the connection URL for your MaxCompute project. URL format:

   jdbc:odps:<maxCompute_endpoint>?project=<maxCompute_project_name>&accessId=<access_id>&accessKey=<access_key>[&interactiveMode={true|false}]

   Example:

   jdbc:odps:https://service.cn-hangzhou.maxcompute.aliyun.com/api?project=test&accessId=xx&accessKey=xx

   Replace the placeholders with your actual values:

   Placeholder	Required	Description
   <maxCompute_endpoint>	Yes	The endpoint of the region where your MaxCompute project is located
   <maxCompute_project_name>	Yes	The name of the MaxCompute project to connect to
   <access_id>	Yes	Your AccessKey ID. Get it from the AccessKey Management page
   <access_key>	Yes	The AccessKey secret that corresponds to your AccessKey ID
   interactiveMode	No	Set to true to enable MaxCompute Query Acceleration (MCQA). Omit this parameter to disable MCQA

4. Click Test Connection.

   Tip: If the test hangs for more than a minute, verify that your endpoint matches the region of your MaxCompute project and that your AccessKey ID and secret are correct.

   If the Connection Test dialog box shows Connected, the connection is established.

   

Step 3: Query and manage data

After connecting, the MaxCompute project appears in the navigation tree on the left. Use the SQL Editor to run queries and the navigation tree to browse your data.

For full documentation on DBeaver features, see the DBeaver wiki.

Browse tables

Expand the connection in the navigation tree to see all tables in the MaxCompute project.

View table schema

Right-click a table and select View Table to see its schema.

Run SQL queries

Go to SQL Editor > New SQL Editor, enter your query, and run it. For example:

SELECT * FROM <your_table_name> LIMIT 10;

Alternatively, right-click a table, select View Project, and go to the Data tab to browse the table data directly.

If SQL queries fail with schema-related errors, enable the schema feature for your project first.

What's next

• Explore the DBeaver documentation to learn about data export, import, and visualization features.

• Enable MaxCompute Query Acceleration (MCQA) by appending &interactiveMode=true to your JDBC URL for faster interactive query performance.