The MaxCompute Java Database Connectivity (JDBC) driver provides a standard JDBC API. You can perform distributed computing and queries on large amounts of data in MaxCompute by using the JDBC API. You can also use the JDBC driver to connect tools that support JDBC to MaxCompute.
Usage notes
Use the MaxCompute JDBC driver to connect to MaxCompute. For more information, see Usage notes.
Use the MaxCompute JDBC driver to connect Business Intelligence (BI) analysis tools to MaxCompute. This way, you can use the tools to analyze data in MaxCompute in a visualized manner. References:
Use the MaxCompute JDBC driver to connect database management tools to MaxCompute. This way, you can use the tools to manage MaxCompute projects. References:
Usage notes
To execute SQL statements and obtain execution results by using the MaxCompute JDBC driver, you must meet the following requirements:
You are a member of a project.
You have the CREATE INSTANCE permission on the project.
You have the SELECT and DOWNLOAD permissions on the table that you want to use.
NoteWhen you use MaxCompute JDBC V1.9 or earlier, a temporary table is automatically created for each query. You can use Tunnel commands to obtain query results from the temporary table. To use these versions, you must have the CREATE TABLE permission.
When you use MaxCompute JDBC V2.2 or later, no temporary table is automatically created for each query. You can call the InstanceTunnel interface to obtain query results, regardless of whether you have the CREATE TABLE permission.
For more information about MaxCompute permissions, see MaxCompute permissions.
MaxCompute provides the data protection feature. If the data protection feature is enabled for a project, you cannot move data out of the project. If you use MaxCompute JDBC of a version earlier than V2.4, no
result setscan be obtained. If you use MaxCompute JDBC V2.4 or later, the number of result rows that you obtain cannot exceed the value of the READ_TABLE_MAX_ROW parameter. For more information about this parameter, see Project operations. For more information about the data protection feature, see Project data protection.The MaxCompute V2.0 data type edition supports more data types, such as TINYINT, SMALLINT, DATETIME, TIMESTAMP, ARRAY, MAP, and STRUCT. To use these new data types, you must run the following command to enable the MaxCompute V2.0 data type edition. For more information, see Data type editions.
set odps.sql.type.system.odps2=true
FAQ
How do I view the log file of the MaxCompute JDBC driver?
By default, the log file of the MaxCompute JDBC driver is stored in the same directory as the JAR package of the MaxCompute JDBC driver. The file name is jdbc.log.
If the code and the MaxCompute JDBC driver are in the same uber JAR package, the log file of the MaxCompute JDBC driver is stored in the same directory as the uber JAR package.
The logs of the MaxCompute JDBC driver show details about JDBC API calls, such as class names, method names, parameters, return values, and the number of rows. You can use the information for debugging.
How do I obtain a MaxCompute Logview URL?
The MaxCompute JDBC driver is encapsulated based on MaxCompute SDK for Java. Logview URLs are generated when you execute SQL statements in the MaxCompute client, MaxCompute Studio, and DataWorks. Logview URLs are also generated when you use the MaxCompute JDBC driver to execute SQL statements. You can use the Logview URLs to view the job status, track job progresses, and obtain job execution results. A Logview URL is configured by using the properties.log4j parameter. By default, logs are displayed as standard error logs.
Does MaxCompute support connection pools and the auto-commit mode?
MaxCompute provides REST services that are different from long connections in traditional databases. It is considered a lightweight task for the MaxCompute JDBC driver to establish a connection. Although the driver supports scenarios in which connection pools are used, connection pools are unnecessary for the MaxCompute JDBC driver.
MaxCompute does not support transactions. Each query is immediately performed on the server. The auto-commit mode is automatically enabled for the MaxCompute JDBC driver. You cannot disable the auto-commit mode for the MaxCompute JDBC driver.
How do I obtain partition fields and data types?
You can use the
Connection.getMetadata()method to obtain DatabaseMetaData objects and use thegetColumns()method to obtain the metadata of all columns.