From bd89d740e646b84ad5f80d7b4c9c8a0532a96e7b Mon Sep 17 00:00:00 2001
From: fwang12 <fwang12@ebay.com>
Date: Fri, 23 Apr 2021 14:53:48 +0800
Subject: [PATCH] [KYUUBI #570] Complete doc for quick start with jdbc

<!--
Thanks for sending a pull request!

Here are some tips for you:
  1. If this is your first time, please read our contributor guidelines: https://kyuubi.readthedocs.io/en/latest/community/contributions.html
  2. If the PR is related to an issue in https://github.com/NetEase/kyuubi/issues, add '[KYUUBI #XXXX]' in your PR title, e.g., '[KYUUBI #XXXX] Your PR title ...'.
  3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][KYUUBI #XXXX] Your PR title ...'.
-->

### _Why are the changes needed?_
<!--
Please clarify why the changes are needed. For instance,
  1. If you add a feature, you can talk about the use case of it.
  2. If you fix a bug, you can clarify why it is a bug.
-->
Complete doc for quick start with jdbc.

### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [ ] Add screenshots for manual tests if appropriate

- [ ] [Run test](https://kyuubi.readthedocs.io/en/latest/tools/testing.html#running-tests) locally before make a pull request

Closes #571 from turboFei/quick_start_with_jdbc.

Closes #570

342885d [fwang12] address comments
8ccf102 [fwang12] [KYUUBI #570] Complete doc for quick start with jdbc

Authored-by: fwang12 <fwang12@ebay.com>
Signed-off-by: ulysses-you <ulyssesyou18@gmail.com>
---
 docs/quick_start/quick_start_with_jdbc.md | 73 +++++++++++++++++++++++
 1 file changed, 73 insertions(+)

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.
+
+```
+<repositories>
+  <repository>
+    <id>central maven repo</id>
+    <name>central maven repo https</name>
+    <url>https://repo.maven.apache.org/maven2</url>
+  </repository>
+<repositories>
+```
+You can add below dependency to your pom file in your application.
+
+```
+<!-- https://mvnrepository.com/artifact/org.apache.hive/hive-jdbc -->
+<dependency>
+    <groupId>org.apache.hive</groupId>
+    <artifactId>hive-jdbc</artifactId>
+    <version>2.3.7</version>
+</dependency>
+<dependency>
+    <groupId>org.apache.hadoop</groupId>
+    <artifactId>hadoop-common</artifactId>
+    <!-- keep consistent with the build hadoop version -->
+    <version>2.7.4</version>
+</dependency>
+```
+
+## 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<Connection>(){
+            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();
+    }
+}
+```