Access Kyuubi with Hive JDBC and ODBC Drivers
Instructions
Kyuubi does not provide its own JDBC Driver so far, as it is fully compatible with Hive JDBC and ODBC drivers that let you connect to popular Business Intelligence (BI) tools to query, analyze and visualize data though Spark SQL engines.
Install Hive JDBC
For programing, the easiest way to get hive-jdbc
is from the maven central. For example,
maven
<dependency>
<groupId>org.apache.hive</groupId>
<artifactId>hive-jdbc</artifactId>
<version>2.3.8</version>
</dependency>
sbt
libraryDependencies += "org.apache.hive" % "hive-jdbc" % "2.3.8"
gradle
implementation group: 'org.apache.hive', name: 'hive-jdbc', version: '2.3.8'
For BI tools, please refer to Quick Start to check the guide for the BI tool used. If you find there is no specific document for the BI tool that you are using, don’t worry, the configuration part for all BI tools are basically same. Also, we will appreciate if you can help us to improve the document.
JDBC URL
JDBC URLs have the following format:
jdbc:hive2://<host>:<port>/<dbName>;<sessionConfs>?<sparkConfs>#<[spark|hive]Vars>
JDBC Parameter | Description |
---|---|
host | The cluster node hosting Kyuubi Server. |
port | The port number to which is Kyuubi Server listening. |
dbName | Optional database name to set the current database to run the query against, use default if absent. |
sessionConfs | Optional Semicolon(;) separated key=value parameters for the JDBC/ODBC driver. All of these will be set to the engine by SparkSession.conf which only accepts Runtime SQL Configurations; |
sparkConfs | Optional Semicolon(;) separated key=value parameters for Kyuubi server to create the corresponding engine, dismissed if engine exists. |
[spark|hive]Vars | Optional Semicolon(;) separated key=value parameters for Spark/Hive variables used for variable substitution. |
Example
jdbc:hive2://localhost:10009/default;spark.sql.adaptive.enabled=true?spark.ui.enabled=false#var_x=y
Unsupported Hive Features
- Connect to HiveServer2 using HTTP transport.
transportMode=http