diff --git a/docs/quick_start/quick_start_with_jdbc.md b/docs/quick_start/quick_start_with_jdbc.md index cfd69f0ec..e63efd4fc 100644 --- a/docs/quick_start/quick_start_with_jdbc.md +++ b/docs/quick_start/quick_start_with_jdbc.md @@ -6,3 +6,76 @@ # Getting Started With Hive JDBC +## How to install JDBC driver +Kyuubi JDBC driver is fully compatible with the 2.3.* version of hive jdbc driver, so we reuse hive JDBC driver to connect to Kyuubi server. + +Add repository to your maven configuration file which may reside in $MAVEN_HOME/conf/settings.xml. + +``` + + + central maven repo + central maven repo https + https://repo.maven.apache.org/maven2 + + +``` +You can add below dependency to your pom file in your application. + +``` + + + org.apache.hive + hive-jdbc + 2.3.7 + + + org.apache.hadoop + hadoop-common + + 2.7.4 + +``` + +## Use JDBC driver with kerberos +The below java code is using a keytab file to login and connect to Kyuubi server by JDBC. + +```java +package org.apache.kyuubi.examples; + +import java.io.IOException; +import java.security.PrivilegedExceptionAction; +import java.sql.*; + +import org.apache.hadoop.security.UserGroupInformation; + +public class JDBCTest { + + private static String driverName = "org.apache.hive.jdbc.HiveDriver"; + private static String kyuubiJdbcUrl = "jdbc:hive2://localhost:10009/default;"; + + public static void main(String[] args) throws IOException, ClassNotFoundException, InterruptedException, SQLException { + String principal = args[0]; // kerberos principal + String keytab = args[1]; // keytab file location + Configuration configuration = new Configuration(); + configuration.set(HADOOP_SECURITY_AUTHENTICATION, "kerberos"); + UserGroupInformation.setConfiguration(configuration); + UserGroupInformation ugi = UserGroupInformation.loginUserFromKeytabAndReturnUGI(principal, keytab); + + Class.forName(driverName); + Connection conn = ugi.doAs(new PrivilegedExceptionAction(){ + public Connection run() throws SQLException { + return DriverManager.getConnection(kyuubiJdbcUrl); + } + }); + Statement st = conn.createStatement(); + ResultSet res = st.executeQuery("show databases"); + while (res.next()) { + System.out.println(res.getString(1)); + } + res.close(); + st.close(); + conn.close(); + } +} +```