This is an automated email from the ASF dual-hosted git repository.
yao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-kyuubi.git
The following commit(s) were added to refs/heads/master by this push:
new 9060bf228 [KYUUBI #3040] [Subtask][#3039] Build the skeleton of client
side documentation
9060bf228 is described below
commit 9060bf2284a34165668a5da9f7f654ad6ea5ae96
Author: Kent Yao <[email protected]>
AuthorDate: Tue Jul 12 11:03:44 2022 +0800
[KYUUBI #3040] [Subtask][#3039] Build the skeleton of client side
documentation
### _Why are the changes needed?_
As a subtask of #3039, this PR aims to build the skeleton of client side
documentation
### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including
negative and positive cases if possible
- [x] Add screenshots for manual tests if appropriate
- [ ] [Run
test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests)
locally before make a pull request
Closes #3041 from yaooqinn/3040.
Closes #3040
754d8a07 [Kent Yao] [KYUUBI #3040] [Subtask][#3039] Build the skeleton of
client side documentation
b574e10d [Kent Yao] [KYUUBI #3040] [Subtask][#3039] Build the skeleton of
client side documentation
721e00c5 [Kent Yao] [KYUUBI #3040] [Subtask][#3039] Build the skeleton of
client side documentation
93fe8c42 [Kent Yao] [KYUUBI #3040] [Subtask][#3039] Build the skeleton of
client side documentation
b9606c94 [Kent Yao] [KYUUBI #3040] [Subtask][#3039] Build the skeleton of
client side documentation
Authored-by: Kent Yao <[email protected]>
Signed-off-by: Kent Yao <[email protected]>
---
.../{index.rst => advanced/configurations.rst} | 12 +-
.../features/engine_pool.rst} | 11 +-
.../features/engine_resouces.rst} | 11 +-
.../features/engine_share_level.rst} | 11 +-
.../features/engine_ttl.rst} | 11 +-
.../features/engine_type.rst} | 11 +-
docs/client/{ => advanced/features}/index.rst | 17 +-
.../{index.rst => advanced/features/plan_only.rst} | 11 +-
.../{index.rst => advanced/features/scala.rst} | 11 +-
docs/client/{ => advanced}/index.rst | 10 +-
docs/client/{ => advanced}/kerberized_kyuubi.md | 2 +-
docs/client/{index.rst => advanced/logging.rst} | 12 +-
.../bi_tools/datagrip.md} | 12 +-
docs/client/bi_tools/dbeaver.rst | 125 ++++++++++++
.../bi_tools/hue.md} | 14 +-
docs/{quick_start => client/bi_tools}/index.rst | 26 +--
docs/client/{index.rst => bi_tools/powerbi.rst} | 12 +-
docs/client/{index.rst => bi_tools/superset.rst} | 12 +-
docs/client/{index.rst => bi_tools/tableau.rst} | 12 +-
.../index.rst => client/cli/hive_beeline.rst} | 23 +--
docs/client/{ => cli}/index.rst | 10 +-
docs/client/{index.rst => cli/kyuubi_beeline.rst} | 11 +-
docs/client/index.rst | 24 ++-
docs/client/{ => jdbc}/hive_jdbc.md | 2 +-
docs/client/{ => jdbc}/index.rst | 12 +-
docs/client/jdbc/kyuubi_jdbc.rst | 160 +++++++++++++++
.../index.rst => client/jdbc/mysql_jdbc.rst} | 18 +-
docs/client/kyuubi_jdbc.md | 96 ---------
docs/client/{ => odbc}/index.rst | 9 +-
docs/client/{ => python}/index.rst | 9 +-
docs/client/{index.rst => python/pyhive.rst} | 11 +-
docs/client/{ => rest}/index.rst | 9 +-
docs/client/{ => thrift}/index.rst | 9 +-
docs/client/{ => ui}/index.rst | 9 +-
.../imgs/dbeaver/configure_database_connection.png | Bin 0 -> 609661 bytes
.../dbeaver/configure_database_connection_ha.png | Bin 0 -> 610635 bytes
docs/imgs/dbeaver/connected.png | Bin 17478 -> 0 bytes
docs/imgs/dbeaver/dbeaver_connnect_to_database.png | Bin 146299 -> 0 bytes
.../dbeaver_connnect_to_database_connection.png | Bin 120468 -> 0 bytes
.../dbeaver_connnect_to_database_driver.png | Bin 119670 -> 0 bytes
.../dbeaver/dbeaver_connnect_to_database_port.png | Bin 133784 -> 0 bytes
docs/imgs/dbeaver/desc_database.png | Bin 389808 -> 0 bytes
docs/imgs/dbeaver/download_driver.png | Bin 121709 -> 0 bytes
docs/imgs/dbeaver/metadata.png | Bin 396949 -> 891987 bytes
docs/imgs/dbeaver/new_database_connection.png | Bin 0 -> 719371 bytes
docs/imgs/dbeaver/query.png | Bin 384802 -> 0 bytes
docs/imgs/dbeaver/query41_result.png | Bin 555745 -> 0 bytes
docs/imgs/dbeaver/tpcds_schema.png | Bin 95662 -> 0 bytes
docs/imgs/dbeaver/viewdata.png | Bin 778197 -> 0 bytes
docs/quick_start/index.rst | 3 -
docs/quick_start/quick_start_with_beeline.md | 94 ---------
docs/quick_start/quick_start_with_dbeaver.md | 224 ---------------------
52 files changed, 433 insertions(+), 643 deletions(-)
diff --git a/docs/client/index.rst b/docs/client/advanced/configurations.rst
similarity index 86%
copy from docs/client/index.rst
copy to docs/client/advanced/configurations.rst
index 18cf7625c..fd9f20a99 100644
--- a/docs/client/index.rst
+++ b/docs/client/advanced/configurations.rst
@@ -13,13 +13,5 @@
See the License for the specific language governing permissions and
limitations under the License.
-
-Client Documentation
-====================
-
-.. toctree::
- :maxdepth: 2
-
- hive_jdbc
- kyuubi_jdbc
- kerberized_kyuubi
+Client Configuration Guide
+==========================
diff --git a/docs/client/index.rst
b/docs/client/advanced/features/engine_pool.rst
similarity index 86%
copy from docs/client/index.rst
copy to docs/client/advanced/features/engine_pool.rst
index 18cf7625c..ed97f3c98 100644
--- a/docs/client/index.rst
+++ b/docs/client/advanced/features/engine_pool.rst
@@ -13,13 +13,6 @@
See the License for the specific language governing permissions and
limitations under the License.
+Enabling Kyuubi Engine Pool
+===========================
-Client Documentation
-====================
-
-.. toctree::
- :maxdepth: 2
-
- hive_jdbc
- kyuubi_jdbc
- kerberized_kyuubi
diff --git a/docs/client/index.rst
b/docs/client/advanced/features/engine_resouces.rst
similarity index 86%
copy from docs/client/index.rst
copy to docs/client/advanced/features/engine_resouces.rst
index 18cf7625c..538c9ec8b 100644
--- a/docs/client/index.rst
+++ b/docs/client/advanced/features/engine_resouces.rst
@@ -13,13 +13,6 @@
See the License for the specific language governing permissions and
limitations under the License.
+Configuring Resources for Kyuubi Engines
+========================================
-Client Documentation
-====================
-
-.. toctree::
- :maxdepth: 2
-
- hive_jdbc
- kyuubi_jdbc
- kerberized_kyuubi
diff --git a/docs/client/index.rst
b/docs/client/advanced/features/engine_share_level.rst
similarity index 86%
copy from docs/client/index.rst
copy to docs/client/advanced/features/engine_share_level.rst
index 18cf7625c..9dd484b7f 100644
--- a/docs/client/index.rst
+++ b/docs/client/advanced/features/engine_share_level.rst
@@ -13,13 +13,6 @@
See the License for the specific language governing permissions and
limitations under the License.
+Sharing and Isolation for Kyuubi Engines
+========================================
-Client Documentation
-====================
-
-.. toctree::
- :maxdepth: 2
-
- hive_jdbc
- kyuubi_jdbc
- kerberized_kyuubi
diff --git a/docs/client/index.rst
b/docs/client/advanced/features/engine_ttl.rst
similarity index 86%
copy from docs/client/index.rst
copy to docs/client/advanced/features/engine_ttl.rst
index 18cf7625c..0ba77519e 100644
--- a/docs/client/index.rst
+++ b/docs/client/advanced/features/engine_ttl.rst
@@ -13,13 +13,6 @@
See the License for the specific language governing permissions and
limitations under the License.
+Setting Time to Live for Kyuubi Engines
+=======================================
-Client Documentation
-====================
-
-.. toctree::
- :maxdepth: 2
-
- hive_jdbc
- kyuubi_jdbc
- kerberized_kyuubi
diff --git a/docs/client/index.rst
b/docs/client/advanced/features/engine_type.rst
similarity index 86%
copy from docs/client/index.rst
copy to docs/client/advanced/features/engine_type.rst
index 18cf7625c..1687678b4 100644
--- a/docs/client/index.rst
+++ b/docs/client/advanced/features/engine_type.rst
@@ -13,13 +13,6 @@
See the License for the specific language governing permissions and
limitations under the License.
+Using Different Kyuubi Engines
+==============================
-Client Documentation
-====================
-
-.. toctree::
- :maxdepth: 2
-
- hive_jdbc
- kyuubi_jdbc
- kerberized_kyuubi
diff --git a/docs/client/index.rst b/docs/client/advanced/features/index.rst
similarity index 84%
copy from docs/client/index.rst
copy to docs/client/advanced/features/index.rst
index 18cf7625c..0491af266 100644
--- a/docs/client/index.rst
+++ b/docs/client/advanced/features/index.rst
@@ -13,13 +13,18 @@
See the License for the specific language governing permissions and
limitations under the License.
-
-Client Documentation
-====================
+Advanced Features
+=================
.. toctree::
:maxdepth: 2
- hive_jdbc
- kyuubi_jdbc
- kerberized_kyuubi
+ engine_type
+ engine_share_level
+ engine_ttl
+ engine_pool
+ engine_resources
+ scala
+ plan_only
+
+
diff --git a/docs/client/index.rst b/docs/client/advanced/features/plan_only.rst
similarity index 86%
copy from docs/client/index.rst
copy to docs/client/advanced/features/plan_only.rst
index 18cf7625c..2f2c7f101 100644
--- a/docs/client/index.rst
+++ b/docs/client/advanced/features/plan_only.rst
@@ -13,13 +13,6 @@
See the License for the specific language governing permissions and
limitations under the License.
+Plan Only Execution Mode
+========================
-Client Documentation
-====================
-
-.. toctree::
- :maxdepth: 2
-
- hive_jdbc
- kyuubi_jdbc
- kerberized_kyuubi
diff --git a/docs/client/index.rst b/docs/client/advanced/features/scala.rst
similarity index 86%
copy from docs/client/index.rst
copy to docs/client/advanced/features/scala.rst
index 18cf7625c..64877c7cb 100644
--- a/docs/client/index.rst
+++ b/docs/client/advanced/features/scala.rst
@@ -13,13 +13,6 @@
See the License for the specific language governing permissions and
limitations under the License.
+Running Scala Snippets
+======================
-Client Documentation
-====================
-
-.. toctree::
- :maxdepth: 2
-
- hive_jdbc
- kyuubi_jdbc
- kerberized_kyuubi
diff --git a/docs/client/index.rst b/docs/client/advanced/index.rst
similarity index 91%
copy from docs/client/index.rst
copy to docs/client/advanced/index.rst
index 18cf7625c..1ff4e59c5 100644
--- a/docs/client/index.rst
+++ b/docs/client/advanced/index.rst
@@ -13,13 +13,13 @@
See the License for the specific language governing permissions and
limitations under the License.
-
-Client Documentation
-====================
+Client Commons
+==============
.. toctree::
:maxdepth: 2
- hive_jdbc
- kyuubi_jdbc
+ configurations
+ logging
kerberized_kyuubi
+ features/index
diff --git a/docs/client/kerberized_kyuubi.md
b/docs/client/advanced/kerberized_kyuubi.md
similarity index 99%
rename from docs/client/kerberized_kyuubi.md
rename to docs/client/advanced/kerberized_kyuubi.md
index 2451d10ff..23a232e7d 100644
--- a/docs/client/kerberized_kyuubi.md
+++ b/docs/client/advanced/kerberized_kyuubi.md
@@ -21,7 +21,7 @@
## Instructions
When Kyuubi is secured by Kerberos, the authentication procedure becomes a
little complicated.
-
+
The graph above shows a simplified kerberos authentication procedure:
1. Kerberos client sends user principal and secret key to KDC. Secret key can
be a password or a keytab file.
diff --git a/docs/client/index.rst b/docs/client/advanced/logging.rst
similarity index 86%
copy from docs/client/index.rst
copy to docs/client/advanced/logging.rst
index 18cf7625c..ab0013aaa 100644
--- a/docs/client/index.rst
+++ b/docs/client/advanced/logging.rst
@@ -13,13 +13,5 @@
See the License for the specific language governing permissions and
limitations under the License.
-
-Client Documentation
-====================
-
-.. toctree::
- :maxdepth: 2
-
- hive_jdbc
- kyuubi_jdbc
- kerberized_kyuubi
+Logging
+=======
diff --git a/docs/quick_start/quick_start_with_datagrip.md
b/docs/client/bi_tools/datagrip.md
similarity index 86%
rename from docs/quick_start/quick_start_with_datagrip.md
rename to docs/client/bi_tools/datagrip.md
index f060ec7f4..517061d02 100644
--- a/docs/quick_start/quick_start_with_datagrip.md
+++ b/docs/client/bi_tools/datagrip.md
@@ -15,7 +15,7 @@
- limitations under the License.
-->
-# Getting Started With Kyuubi and DataGrip
+# DataGrip
## What is DataGrip
[DataGrip](https://www.jetbrains.com/datagrip/) is a multi-engine database
environment released by JetBrains, supporting MySQL and PostgreSQL, Microsoft
SQL Server and Oracle, Sybase, DB2, SQLite, HyperSQL, Apache Derby, and H2.
@@ -23,7 +23,7 @@
### Get DataGrip And Install
Please go to [Download DataGrip](https://www.jetbrains.com/datagrip/download)
to get and install an appropriate version for yourself.
### Get Kyuubi Started
-[Get kyuubi server started](quick_start.md) before you try DataGrip with
kyuubi.
+[Get kyuubi server started](../../quick_start.md) before you try DataGrip with
kyuubi.
For debugging purpose, you can use `tail -f` or `tailf` to track the server
log.
## Configurations
@@ -32,11 +32,11 @@ After you install DataGrip, just launch it.
### Select Database
Substantially, this step is to choose a JDBC Driver type to use later. We can
choose Apache Hive to set up a driver for Kyuubi.
-
+
### Datasource Driver
You should first download the missing driver files. Just click on the link
below, DataGrip will download and install those.
-
+
### Generic JDBC Connection Settings
After install drivers, you should configure the right host and port which you
can find in kyuubi server log. By default, we use `localhost` and `10009` to
configure.
@@ -44,7 +44,7 @@ Of course, you can fill other configs.
After generic configs, you can use test connection to test.
-
+
## Interacting With Kyuubi Server
Now, you can interact with Kyuubi server.
@@ -52,6 +52,6 @@ The left side of the photo is the table, and the right side
of the photo is the
You can interact through the visual interface or code.
-
+
## The End
There are many other amazing features in both Kyuubi and DataGrip and here is
just the tip of the iceberg. The rest is for you to discover.
\ No newline at end of file
diff --git a/docs/client/bi_tools/dbeaver.rst b/docs/client/bi_tools/dbeaver.rst
new file mode 100644
index 000000000..006498544
--- /dev/null
+++ b/docs/client/bi_tools/dbeaver.rst
@@ -0,0 +1,125 @@
+.. Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+.. http://www.apache.org/licenses/LICENSE-2.0
+
+.. Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+DBeaver
+=======
+
+What is DBeaver
+---------------
+
+.. image::
https://raw.githubusercontent.com/wiki/dbeaver/dbeaver/images/dbeaver-icon-64x64.png
+
+`DBeaver`_ is a free multi-platform database tool for developers, database
administrators, analysts, and all people who need to work with databases.
+Supports all popular databases as well as kyuubi JDBC.
+
+.. seealso:: `DBeaver Wiki`
+
+Installation
+------------
+Please go to `Download DBeaver`_ page to get and install an appropriate
release version for yourself.
+
+.. versionadded:: 22.1.0(dbeaver)
+ DBeaver officially supports apache kyuubi JDBC driver since 06 Jun 2022 via
`PR 16567 <https://github.com/dbeaver/dbeaver/issues/16567>`_.
+
+Using DBeaver with Kyuubi
+-------------------------
+If you have successfully installed dbeaver, just hit the button to launch it.
+
+New Connection
+**************
+
+Firstly, we need to create a database connection against a live kyuubi server.
+You are able to find the kyuubi jdbc driver since dbeaver 22.1.0, as shown in
the following figure.
+
+.. image:: ../../imgs/dbeaver/new_database_connection.png
+
+.. note::
+ We can also choose Apache Hive or Apache Spark to set up a driver for
Kyuubi, because they are compatible with the same client.
+
+Configure Connection
+********************
+
+Secondly, we configure the JDBC connection settings to format an underlying
kyuubi JDBC connection URL string.
+
+Basic Connection Settings
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The basic connection setting contains a minimal set of items you need to talk
with kyuubi server,
+
+- Host - hostname or IP address that the kyuubi server bound with, default:
`localhost`.
+- Port - port that the kyuubi server listening to, default: `10009`.
+- Database/Schema - database or schema to use, default: `default`.
+- Authentication - identity information, such as user/password, based on the
server authentication mechanism.
+
+Session Configurations
+^^^^^^^^^^^^^^^^^^^^^^
+
+Session configuration list is an optional part of kyuubi JDBC URLs, which are
very helpful to override some configurations of the kyuubi server at session
scope.
+The setup page of dbeaver does not contain any text box for such behavior.
+However, we can append the semicolon-separated configuration pairs to the
Database/Schema filed leading with a number sign(#).
+Though it's a bit weird, but it works.
+
+.. image:: ../../imgs/dbeaver/configure_database_connection.png
+
+As an example, shown in the picture above, the engine uses 2 gigabytes memory
for the driver process of kyuubi engine and will be terminated after idle for
30 seconds.
+
+Connecting in HA mode
+^^^^^^^^^^^^^^^^^^^^^
+
+Kyuubi supports HA by service discovery over Apache Zookeeper cluster.
+
+.. image:: ../../imgs/dbeaver/configure_database_connection_ha.png
+
+As an example, shown in the above picture, the Host and Port fields can be
used to concat the comma separated zookeeper peers,
+while the `serviceDiscoveryMode` and `zooKeeperNamespace` are appended to the
Database/Schema field.
+
+Test Connection
+***************
+
+It is not necessary but recommended to click `Test Connection` to verify the
connection is set correctly.
+If something wrong happens at the client side or server side, we can debug
ahead with the error message.
+
+SQL Operations
+**************
+
+Now, we can use the SQL editor to write queries to interact with Kyuubi server
through the connection.
+
+.. code-block:: sql
+
+ DESC NAMESPACE DEFAULT;
+
+.. code-block:: sql
+
+ CREATE TABLE spark_catalog.`default`.SRC(KEY INT, VALUE STRING) USING
PARQUET;
+ INSERT INTO TABLE spark_catalog.`default`.SRC VALUES (11215016, 'Kent Yao');
+
+.. code-block:: sql
+
+ SELECT KEY % 10 AS ID, SUBSTRING(VALUE, 1, 4) AS NAME FROM
spark_catalog.`default`.SRC;
+
+.. image:: ../../imgs/dbeaver/metadata.png
+
+.. code-block:: sql
+
+ DROP TABLE spark_catalog.`default`.SRC;
+
+Client Authentication
+---------------------
+For kerberized kyuubi clusters, please refer to `Kerberos Authentication`_ for
more information.
+
+.. _DBeaver: https://dbeaver.io/
+.. _DBeaver Wiki: https://github.com/dbeaver/dbeaver/wiki
+.. _Download DBeaver: https://dbeaver.io/download/
+.. _Kerberos Authentication: ../advanced/kerberized_kyuubi.html#bi-tools
diff --git a/docs/quick_start/quick_start_with_hue.md
b/docs/client/bi_tools/hue.md
similarity index 92%
rename from docs/quick_start/quick_start_with_hue.md
rename to docs/client/bi_tools/hue.md
index 3d782c276..ff116326b 100644
--- a/docs/quick_start/quick_start_with_hue.md
+++ b/docs/client/bi_tools/hue.md
@@ -16,7 +16,7 @@
-->
-# Getting Started with Kyuubi and Cloudera Hue
+# Cloudera Hue
## What is Hue
@@ -26,7 +26,7 @@
### Get Kyuubi Started
-[Get the server Started](quick_start.md) first before your try Hue with Kyuubi.
+[Get the server Started](../../quick_start.md) first before your try Hue with
Kyuubi.
```bash
Welcome to
@@ -90,11 +90,11 @@ docker run -p 8888:8888 -v
$PWD/hue.ini:/usr/share/hue/desktop/conf/hue.ini geth
Go http://localhost:8888/ and follow the guide to create an account.
-
+
Having fun with Hue and Kyuubi!
-
+
## For CDH 6.x Users
@@ -103,7 +103,7 @@ overwrite the `desktop.app_blacklist` to remove this
restriction.
Config Hue in Cloudera Manager.
-
+
Refer following configuration and tune it to fit your environment.
```
@@ -123,8 +123,8 @@ sql_server_port=10009
You need to restart the Hue Service to activate the configuration changes, and
then Spark SQL will available in editor list.
-
+
Having fun with Hue and Kyuubi!
-
+
diff --git a/docs/quick_start/index.rst b/docs/client/bi_tools/index.rst
similarity index 64%
copy from docs/quick_start/index.rst
copy to docs/client/bi_tools/index.rst
index 1fa85aa4d..b11076afb 100644
--- a/docs/quick_start/index.rst
+++ b/docs/client/bi_tools/index.rst
@@ -13,20 +13,20 @@
See the License for the specific language governing permissions and
limitations under the License.
+Business Intelligence Tools and SQL IDEs
+========================================
-Quick Start
-===========
+Kyuubi provides a standard JDBC/ODBC interface over thrift that allows various
existing BI tools, SQL clients/IDEs to connect with.
-In this section, you will learn how to setup and interact with kyuubi quickly.
+.. note:: Is your favorite tool missing?
+ `Report an feature request
<https://kyuubi.apache.org/issue_tracking.html>`_ or help us document it.
.. toctree::
- :maxdepth: 2
-
- quick_start
- quick_start_with_helm
- quick_start_with_dbeaver
- quick_start_with_beeline
- quick_start_with_jdbc
- quick_start_with_datagrip
- quick_start_with_hue
-
+ :maxdepth: 1
+
+ superset
+ hue
+ datagrip
+ dbeaver
+ powerbi
+ tableau
diff --git a/docs/client/index.rst b/docs/client/bi_tools/powerbi.rst
similarity index 80%
copy from docs/client/index.rst
copy to docs/client/bi_tools/powerbi.rst
index 18cf7625c..2da674784 100644
--- a/docs/client/index.rst
+++ b/docs/client/bi_tools/powerbi.rst
@@ -13,13 +13,9 @@
See the License for the specific language governing permissions and
limitations under the License.
+`PowerBI`_
+==========
-Client Documentation
-====================
+.. warning:: The document you are visiting now is incomplete, please help
kyuubi community to fix it if appropriate for you.
-.. toctree::
- :maxdepth: 2
-
- hive_jdbc
- kyuubi_jdbc
- kerberized_kyuubi
+.. _PowerBI: https://powerbi.microsoft.com/en-us/
\ No newline at end of file
diff --git a/docs/client/index.rst b/docs/client/bi_tools/superset.rst
similarity index 78%
copy from docs/client/index.rst
copy to docs/client/bi_tools/superset.rst
index 18cf7625c..52afdd9a6 100644
--- a/docs/client/index.rst
+++ b/docs/client/bi_tools/superset.rst
@@ -13,13 +13,9 @@
See the License for the specific language governing permissions and
limitations under the License.
+`Apache Superset`_
+==================
-Client Documentation
-====================
+.. warning:: The document you are visiting now is incomplete, please help
kyuubi community to fix it if appropriate for you.
-.. toctree::
- :maxdepth: 2
-
- hive_jdbc
- kyuubi_jdbc
- kerberized_kyuubi
+.. _Apache Superset: https://superset.apache.org/
\ No newline at end of file
diff --git a/docs/client/index.rst b/docs/client/bi_tools/tableau.rst
similarity index 81%
copy from docs/client/index.rst
copy to docs/client/bi_tools/tableau.rst
index 18cf7625c..ef6e6aabf 100644
--- a/docs/client/index.rst
+++ b/docs/client/bi_tools/tableau.rst
@@ -13,13 +13,9 @@
See the License for the specific language governing permissions and
limitations under the License.
+`Tableau`_
+==========
-Client Documentation
-====================
+.. warning:: The document you are visiting now is incomplete, please help
kyuubi community to fix it if appropriate for you.
-.. toctree::
- :maxdepth: 2
-
- hive_jdbc
- kyuubi_jdbc
- kerberized_kyuubi
+.. _Tableau: https://www.tableau.com/
\ No newline at end of file
diff --git a/docs/quick_start/index.rst b/docs/client/cli/hive_beeline.rst
similarity index 55%
copy from docs/quick_start/index.rst
copy to docs/client/cli/hive_beeline.rst
index 1fa85aa4d..fda925aa1 100644
--- a/docs/quick_start/index.rst
+++ b/docs/client/cli/hive_beeline.rst
@@ -13,20 +13,19 @@
See the License for the specific language governing permissions and
limitations under the License.
+Hive Beeline
+============
-Quick Start
-===========
+Kyuubi supports Apache Hive beeline that works with Kyuubi server.
+Hive beeline is a `SQLLine CLI <http://sqlline.sourceforge.net/>`_ based on
the `Hive JDBC Driver <../jdbc/hive_jdbc.html>`_.
-In this section, you will learn how to setup and interact with kyuubi quickly.
+Prerequisites
+-------------
-.. toctree::
- :maxdepth: 2
+- Kyuubi server installed and launched.
+- Hive beeline installed
- quick_start
- quick_start_with_helm
- quick_start_with_dbeaver
- quick_start_with_beeline
- quick_start_with_jdbc
- quick_start_with_datagrip
- quick_start_with_hue
+.. important:: Kyuubi does not support embedded mode which beeline and server
run in the same process.
+ It always uses remote mode for connecting beeline with a separate server
process over thrift.
+.. warning:: The document you are visiting now is incomplete, please help
kyuubi community to fix it if appropriate for you.
diff --git a/docs/client/index.rst b/docs/client/cli/index.rst
similarity index 89%
copy from docs/client/index.rst
copy to docs/client/cli/index.rst
index 18cf7625c..61be9ad8c 100644
--- a/docs/client/index.rst
+++ b/docs/client/cli/index.rst
@@ -13,13 +13,11 @@
See the License for the specific language governing permissions and
limitations under the License.
-
-Client Documentation
-====================
+Command Line Interface(CLI)s
+============================
.. toctree::
:maxdepth: 2
- hive_jdbc
- kyuubi_jdbc
- kerberized_kyuubi
+ kyuubi_beeline
+ hive_beeline
diff --git a/docs/client/index.rst b/docs/client/cli/kyuubi_beeline.rst
similarity index 83%
copy from docs/client/index.rst
copy to docs/client/cli/kyuubi_beeline.rst
index 18cf7625c..e21781058 100644
--- a/docs/client/index.rst
+++ b/docs/client/cli/kyuubi_beeline.rst
@@ -13,13 +13,10 @@
See the License for the specific language governing permissions and
limitations under the License.
+Kyuubi Beeline
+==============
+
+.. warning:: The document you are visiting now is incomplete, please help
kyuubi community to fix it if appropriate for you.
-Client Documentation
-====================
-.. toctree::
- :maxdepth: 2
- hive_jdbc
- kyuubi_jdbc
- kerberized_kyuubi
diff --git a/docs/client/index.rst b/docs/client/index.rst
index 18cf7625c..049f59348 100644
--- a/docs/client/index.rst
+++ b/docs/client/index.rst
@@ -13,13 +13,27 @@
See the License for the specific language governing permissions and
limitations under the License.
+Clients
+=======
-Client Documentation
-====================
+This section aims to document the APIs, clients and tools for end-users who
are not necessary to care about deployment at the kyuubi server side.
+
+Kyuubi provides standards-based drivers for JDBC, and ODBC enabling developers
to build database applications in their language of choice.
+
+In addition, APIs like REST, Thrift, etc., allow developers to access kyuubi
directly and flexibly.
+
+.. note::
+ When you try some of the examples in this section, make sure you have a
available server.
.. toctree::
:maxdepth: 2
- hive_jdbc
- kyuubi_jdbc
- kerberized_kyuubi
+ jdbc/index
+ cli/index
+ bi_tools/index
+ odbc/index
+ thrift/index
+ rest/index
+ ui/index
+ python/index
+ advanced/index
\ No newline at end of file
diff --git a/docs/client/hive_jdbc.md b/docs/client/jdbc/hive_jdbc.md
similarity index 98%
rename from docs/client/hive_jdbc.md
rename to docs/client/jdbc/hive_jdbc.md
index 8701a4e5a..f0886d7cf 100644
--- a/docs/client/hive_jdbc.md
+++ b/docs/client/jdbc/hive_jdbc.md
@@ -16,7 +16,7 @@
-->
-# Access Kyuubi with Hive JDBC and ODBC Drivers
+# Hive JDBC Driver
## Instructions
diff --git a/docs/client/index.rst b/docs/client/jdbc/index.rst
similarity index 91%
copy from docs/client/index.rst
copy to docs/client/jdbc/index.rst
index 18cf7625c..31871f138 100644
--- a/docs/client/index.rst
+++ b/docs/client/jdbc/index.rst
@@ -13,13 +13,13 @@
See the License for the specific language governing permissions and
limitations under the License.
-
-Client Documentation
-====================
+JDBC Drivers
+============
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
- hive_jdbc
kyuubi_jdbc
- kerberized_kyuubi
+ hive_jdbc
+ mysql_jdbc
+
diff --git a/docs/client/jdbc/kyuubi_jdbc.rst b/docs/client/jdbc/kyuubi_jdbc.rst
new file mode 100644
index 000000000..fdc40d599
--- /dev/null
+++ b/docs/client/jdbc/kyuubi_jdbc.rst
@@ -0,0 +1,160 @@
+.. Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+.. http://www.apache.org/licenses/LICENSE-2.0
+
+.. Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+Kyuubi Hive JDBC Driver
+=======================
+
+.. versionadded:: 1.4.0
+ Since 1.4.0, kyuubi community maintains a forked hive jdbc driver module
and provides both shaded and non-shaded packages.
+
+This packages aims to support some missing functionalities of the original
hive jdbc.
+For kyuubi engines that support multiple catalogs, it provides meta APIs for
better support.
+The behaviors of the original hive jdbc have remained.
+
+To access a Hive data warehouse or new lakehouse formats, such as Apache
Iceberg/Hudi, delta lake using the kyuubi jdbc driver for Apache kyuubi, you
need to configure
+the following:
+
+- The list of driver library files - :ref:`referencing-libraries`.
+- The Driver or DataSource class - :ref:`registering_class`.
+- The connection URL for the driver - :ref:`building_url`
+
+.. _referencing-libraries:
+
+Referencing the JDBC Driver Libraries
+-------------------------------------
+
+Before you use the jdbc driver for Apache Kyuubi, the JDBC application or Java
code that
+you are using to connect to your data must be able to access the driver JAR
files.
+
+Using the Driver in Java Code
+*****************************
+
+In the code, specify the artifact `kyuubi-hive-jdbc-shaded` from `Maven
Central`_ according to the build tool you use.
+
+Maven
+^^^^^
+
+.. code-block:: xml
+
+ <dependency>
+ <groupId>org.apache.kyuubi</groupId>
+ <artifactId>kyuubi-hive-jdbc-shaded</artifactId>
+ <version>1.5.2-incubating</version>
+ </dependency>
+
+Sbt
+^^^
+
+.. code-block:: sbt
+
+ libraryDependencies += "org.apache.kyuubi" % "kyuubi-hive-jdbc-shaded" %
"1.5.2-incubating"
+
+
+Gradle
+^^^^^^
+
+.. code-block:: gradle
+
+ implementation group: 'org.apache.kyuubi', name: 'kyuubi-hive-jdbc-shaded',
version: '1.5.2-incubating'
+
+Using the Driver in a JDBC Application
+**************************************
+
+For `JDBC Applications`_, such as BI tools, SQL IDEs, please check the
specific guide for detailed information.
+
+.. note:: Is your favorite tool missing?
+ `Report an feature request
<https://kyuubi.apache.org/issue_tracking.html>`_ or help us document it.
+
+.. _registering_class:
+
+Registering the Driver Class
+----------------------------
+
+Before connecting to your data, you must register the JDBC Driver class for
your application.
+
+- org.apache.kyuubi.jdbc.KyuubiHiveDriver
+- org.apache.kyuubi.jdbc.KyuubiDriver (Deprecated)
+
+The following sample code shows how to use the `java.sql.DriverManager`_ class
to establish a
+connection for JDBC:
+
+.. code-block:: java
+
+ private static Connection connectViaDM() throws Exception
+ {
+ Connection connection = null;
+ connection = DriverManager.getConnection(CONNECTION_URL);
+ return connection;
+ }
+
+.. _building_url:
+
+Building the Connection URL
+---------------------------
+
+Basic Connection URL format
+***************************
+
+Use the connection URL to supply connection information to the kyuubi server
or cluster that you are
+accessing. The following is the format of the connection URL for the Kyuubi
Hive JDBC Driver
+
+.. code-block:: jdbc
+
+
jdbc:subprotocol://host:port/schema;<clientProperties;><[#|?]sessionProperties>
+
+- subprotocol: kyuubi or hive2
+- host: DNS or IP address of the kyuubi server
+- port: The number of the TCP port that the server uses to listen for client
requests
+- dbName: Optional database name to set the current database to run the query
against, use `default` if absent.
+- clientProperties: Optional `semicolon(;)` separated `key=value` parameters
identified and affect the client behavior locally. e.g., user=foo;password=bar.
+- sessionProperties: Optional `semicolon(;)` separated `key=value` parameters
used to configure the session, operation or background engines.
+ For instance, `kyuubi.engine.share.level=CONNECTION` determines the
background engine instance is used only by the current connection.
`spark.ui.enabled=false` disables the Spark UI of the engine.
+
+.. important::
+ - The sessionProperties MUST come after a leading number sign(#) or
question mark (?).
+ - Properties are case-sensitive
+ - Do not duplicate properties in the connection URL
+
+Connection URL over Http
+************************
+
+.. versionadded:: 1.6.0
+
+.. code-block:: jdbc
+
+
jdbc:subprotocol://host:port/schema;transportMode=http;httpPath=<http_endpoint>
+
+- http_endpoint is the corresponding HTTP endpoint configured by
`kyuubi.frontend.thrift.http.path` at the server side.
+
+Connection URL over Service Discovery
+*************************************
+
+.. code-block:: jdbc
+
+ jdbc:subprotocol://<zookeeper
quorum>/;serviceDiscoveryMode=zooKeeper;zooKeeperNamespace=kyuubi
+
+- zookeeper quorum is the corresponding zookeeper cluster configured by
`kyuubi.ha.zookeeper.quorum` at the server side.
+- zooKeeperNamespace is the corresponding namespace configured by
`kyuubi.ha.zookeeper.namespace` at the server side.
+
+Authentication
+--------------
+
+
+DataTypes
+---------
+
+.. _Maven Central:
https://mvnrepository.com/artifact/org.apache.kyuubi/kyuubi-hive-jdbc-shaded
+.. _JDBC Applications: ../bi_tools/index.html
+.. _java.sql.DriverManager:
https://docs.oracle.com/javase/8/docs/api/java/sql/DriverManager.html
diff --git a/docs/quick_start/index.rst b/docs/client/jdbc/mysql_jdbc.rst
similarity index 69%
copy from docs/quick_start/index.rst
copy to docs/client/jdbc/mysql_jdbc.rst
index 1fa85aa4d..0702fcdbe 100644
--- a/docs/quick_start/index.rst
+++ b/docs/client/jdbc/mysql_jdbc.rst
@@ -14,19 +14,13 @@
limitations under the License.
-Quick Start
-===========
+`MySQL Connectors`_
+================
-In this section, you will learn how to setup and interact with kyuubi quickly.
+.. versionadded:: 1.4.0
-.. toctree::
- :maxdepth: 2
+Kyuubi provides an frontend service that enables the connectivity and
accessibility from MySQL connectors.
- quick_start
- quick_start_with_helm
- quick_start_with_dbeaver
- quick_start_with_beeline
- quick_start_with_jdbc
- quick_start_with_datagrip
- quick_start_with_hue
+.. warning:: The document you are visiting now is incomplete, please help
kyuubi community to fix it if appropriate for you.
+.. _MySQL Connectors: https://www.mysql.com/products/connector/
diff --git a/docs/client/kyuubi_jdbc.md b/docs/client/kyuubi_jdbc.md
deleted file mode 100644
index ca05564e9..000000000
--- a/docs/client/kyuubi_jdbc.md
+++ /dev/null
@@ -1,96 +0,0 @@
-<!--
- - Licensed to the Apache Software Foundation (ASF) under one or more
- - contributor license agreements. See the NOTICE file distributed with
- - this work for additional information regarding copyright ownership.
- - The ASF licenses this file to You under the Apache License, Version 2.0
- - (the "License"); you may not use this file except in compliance with
- - the License. You may obtain a copy of the License at
- -
- - http://www.apache.org/licenses/LICENSE-2.0
- -
- - Unless required by applicable law or agreed to in writing, software
- - distributed under the License is distributed on an "AS IS" BASIS,
- - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- - See the License for the specific language governing permissions and
- - limitations under the License.
- -->
-
-
-# Access Kyuubi with Kyuubi JDBC Drivers
-
-## Install Kyuubi JDBC
-
-For programing, the easiest way to get `kyuubi-hive-jdbc-shaded` is from [the
maven
central](https://mvnrepository.com/artifact/org.apache.kyuubi/kyuubi-hive-jdbc-shaded).
For example,
-
-- **maven**
-```xml
-<dependency>
- <groupId>org.apache.kyuubi</groupId>
- <artifactId>kyuubi-hive-jdbc-shaded</artifactId>
- <version>1.5.0-incubating</version>
-</dependency>
-```
-
-- **sbt**
-```scala
-libraryDependencies += "org.apache.kyuubi" % "kyuubi-hive-jdbc-shaded" %
"1.5.0-incubating"
-```
-
-- **gradle**
-```gradle
-implementation group: 'org.apache.kyuubi', name: 'kyuubi-hive-jdbc-shaded',
version: '1.5.0-incubating'
-```
-
-For BI tools, please refer to [Quick Start](../quick_start/index.html) 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 the 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>;<sessionVars>?<kyuubiConfs>#<[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.
-sessionVars | Optional `Semicolon(;)` separated `key=value` parameters for the
JDBC/ODBC driver. Such as `user`, `password` and `hive.server2.proxy.user`.
-kyuubiConfs | 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;hive.server2.proxy.user=proxy_user?kyuubi.engine.share.level=CONNECTION;spark.ui.enabled=false#var_x=y
-```
-
-## Alert
-
-If you already have `hadoop-common` dependency in your classpath, you should
exclude `hadoop-client-api` from `kyuubi-hive-jdbc-shaded` to avoid class
confliction. For example:
-
-- **maven**
-```xml
-<dependency>
- <groupId>org.apache.kyuubi</groupId>
- <artifactId>kyuubi-hive-jdbc-shaded</artifactId>
- <version>1.5.0-incubating</version>
- <exclusion>
- <groupId>org.apache.hadoop</groupId>
- <artifactId>hadoop-client-api</artifactId>
- </exclusion>
-</dependency>
-```
-
-- **sbt**
-```scala
-libraryDependencies += "org.apache.kyuubi" % "kyuubi-hive-jdbc-shaded" %
"1.5.0-incubating" exclude("org.apache.hadoop", "hadoop-client-api")
-```
-
-- **gradle**
-```gradle
-implementation (group: 'org.apache.kyuubi', name: 'kyuubi-hive-jdbc-shaded',
version: '1.5.0-incubating') { exclude group: 'org.apache.hadoop', module:
'hadoop-client-api' }
-```
\ No newline at end of file
diff --git a/docs/client/index.rst b/docs/client/odbc/index.rst
similarity index 89%
copy from docs/client/index.rst
copy to docs/client/odbc/index.rst
index 18cf7625c..0d4ed8b94 100644
--- a/docs/client/index.rst
+++ b/docs/client/odbc/index.rst
@@ -14,12 +14,11 @@
limitations under the License.
-Client Documentation
-====================
+ODBC Drivers
+============================
.. toctree::
:maxdepth: 2
- hive_jdbc
- kyuubi_jdbc
- kerberized_kyuubi
+ todo
+
diff --git a/docs/client/index.rst b/docs/client/python/index.rst
similarity index 89%
copy from docs/client/index.rst
copy to docs/client/python/index.rst
index 18cf7625c..6dfbec071 100644
--- a/docs/client/index.rst
+++ b/docs/client/python/index.rst
@@ -14,12 +14,11 @@
limitations under the License.
-Client Documentation
-====================
+Python DB-APIs
+==============
.. toctree::
:maxdepth: 2
- hive_jdbc
- kyuubi_jdbc
- kerberized_kyuubi
+ pyhive
+
diff --git a/docs/client/index.rst b/docs/client/python/pyhive.rst
similarity index 80%
copy from docs/client/index.rst
copy to docs/client/python/pyhive.rst
index 18cf7625c..fe2f9cf6d 100644
--- a/docs/client/index.rst
+++ b/docs/client/python/pyhive.rst
@@ -14,12 +14,9 @@
limitations under the License.
-Client Documentation
-====================
+`PyHive`_
+=========
-.. toctree::
- :maxdepth: 2
+.. warning:: The document you are visiting now is incomplete, please help
kyuubi community to fix it if appropriate for you.
- hive_jdbc
- kyuubi_jdbc
- kerberized_kyuubi
+.. _PyHive: https://github.com/dropbox/PyHive
diff --git a/docs/client/index.rst b/docs/client/rest/index.rst
similarity index 89%
copy from docs/client/index.rst
copy to docs/client/rest/index.rst
index 18cf7625c..3a7683e4c 100644
--- a/docs/client/index.rst
+++ b/docs/client/rest/index.rst
@@ -14,12 +14,11 @@
limitations under the License.
-Client Documentation
-====================
+RESTful APIs and Clients
+========================
.. toctree::
:maxdepth: 2
- hive_jdbc
- kyuubi_jdbc
- kerberized_kyuubi
+ hive_beeline
+
diff --git a/docs/client/index.rst b/docs/client/thrift/index.rst
similarity index 89%
copy from docs/client/index.rst
copy to docs/client/thrift/index.rst
index 18cf7625c..e7def4824 100644
--- a/docs/client/index.rst
+++ b/docs/client/thrift/index.rst
@@ -14,12 +14,11 @@
limitations under the License.
-Client Documentation
-====================
+Thrift APIs
+===========
.. toctree::
:maxdepth: 2
- hive_jdbc
- kyuubi_jdbc
- kerberized_kyuubi
+ hive_beeline
+
diff --git a/docs/client/index.rst b/docs/client/ui/index.rst
similarity index 89%
copy from docs/client/index.rst
copy to docs/client/ui/index.rst
index 18cf7625c..63a02cbd4 100644
--- a/docs/client/index.rst
+++ b/docs/client/ui/index.rst
@@ -14,12 +14,11 @@
limitations under the License.
-Client Documentation
-====================
+Web UI
+======
.. toctree::
:maxdepth: 2
- hive_jdbc
- kyuubi_jdbc
- kerberized_kyuubi
+ hive_beeline
+
diff --git a/docs/imgs/dbeaver/configure_database_connection.png
b/docs/imgs/dbeaver/configure_database_connection.png
new file mode 100644
index 000000000..f69401487
Binary files /dev/null and
b/docs/imgs/dbeaver/configure_database_connection.png differ
diff --git a/docs/imgs/dbeaver/configure_database_connection_ha.png
b/docs/imgs/dbeaver/configure_database_connection_ha.png
new file mode 100644
index 000000000..0caae3cfe
Binary files /dev/null and
b/docs/imgs/dbeaver/configure_database_connection_ha.png differ
diff --git a/docs/imgs/dbeaver/connected.png b/docs/imgs/dbeaver/connected.png
deleted file mode 100644
index 372cf2560..000000000
Binary files a/docs/imgs/dbeaver/connected.png and /dev/null differ
diff --git a/docs/imgs/dbeaver/dbeaver_connnect_to_database.png
b/docs/imgs/dbeaver/dbeaver_connnect_to_database.png
deleted file mode 100644
index 9b8a2e475..000000000
Binary files a/docs/imgs/dbeaver/dbeaver_connnect_to_database.png and /dev/null
differ
diff --git a/docs/imgs/dbeaver/dbeaver_connnect_to_database_connection.png
b/docs/imgs/dbeaver/dbeaver_connnect_to_database_connection.png
deleted file mode 100644
index 2442f4e4c..000000000
Binary files a/docs/imgs/dbeaver/dbeaver_connnect_to_database_connection.png
and /dev/null differ
diff --git a/docs/imgs/dbeaver/dbeaver_connnect_to_database_driver.png
b/docs/imgs/dbeaver/dbeaver_connnect_to_database_driver.png
deleted file mode 100644
index 35442b8ae..000000000
Binary files a/docs/imgs/dbeaver/dbeaver_connnect_to_database_driver.png and
/dev/null differ
diff --git a/docs/imgs/dbeaver/dbeaver_connnect_to_database_port.png
b/docs/imgs/dbeaver/dbeaver_connnect_to_database_port.png
deleted file mode 100644
index 15669f734..000000000
Binary files a/docs/imgs/dbeaver/dbeaver_connnect_to_database_port.png and
/dev/null differ
diff --git a/docs/imgs/dbeaver/desc_database.png
b/docs/imgs/dbeaver/desc_database.png
deleted file mode 100644
index f4a18d00b..000000000
Binary files a/docs/imgs/dbeaver/desc_database.png and /dev/null differ
diff --git a/docs/imgs/dbeaver/download_driver.png
b/docs/imgs/dbeaver/download_driver.png
deleted file mode 100644
index d936da8fb..000000000
Binary files a/docs/imgs/dbeaver/download_driver.png and /dev/null differ
diff --git a/docs/imgs/dbeaver/metadata.png b/docs/imgs/dbeaver/metadata.png
index 6d422bcc2..3d35296c3 100644
Binary files a/docs/imgs/dbeaver/metadata.png and
b/docs/imgs/dbeaver/metadata.png differ
diff --git a/docs/imgs/dbeaver/new_database_connection.png
b/docs/imgs/dbeaver/new_database_connection.png
new file mode 100644
index 000000000..7a024695d
Binary files /dev/null and b/docs/imgs/dbeaver/new_database_connection.png
differ
diff --git a/docs/imgs/dbeaver/query.png b/docs/imgs/dbeaver/query.png
deleted file mode 100644
index f21bd2d10..000000000
Binary files a/docs/imgs/dbeaver/query.png and /dev/null differ
diff --git a/docs/imgs/dbeaver/query41_result.png
b/docs/imgs/dbeaver/query41_result.png
deleted file mode 100644
index bee75b904..000000000
Binary files a/docs/imgs/dbeaver/query41_result.png and /dev/null differ
diff --git a/docs/imgs/dbeaver/tpcds_schema.png
b/docs/imgs/dbeaver/tpcds_schema.png
deleted file mode 100644
index b610c6155..000000000
Binary files a/docs/imgs/dbeaver/tpcds_schema.png and /dev/null differ
diff --git a/docs/imgs/dbeaver/viewdata.png b/docs/imgs/dbeaver/viewdata.png
deleted file mode 100644
index 4a0280b62..000000000
Binary files a/docs/imgs/dbeaver/viewdata.png and /dev/null differ
diff --git a/docs/quick_start/index.rst b/docs/quick_start/index.rst
index 1fa85aa4d..4832ac57e 100644
--- a/docs/quick_start/index.rst
+++ b/docs/quick_start/index.rst
@@ -24,9 +24,6 @@ In this section, you will learn how to setup and interact
with kyuubi quickly.
quick_start
quick_start_with_helm
- quick_start_with_dbeaver
quick_start_with_beeline
quick_start_with_jdbc
- quick_start_with_datagrip
- quick_start_with_hue
diff --git a/docs/quick_start/quick_start_with_beeline.md
b/docs/quick_start/quick_start_with_beeline.md
deleted file mode 100644
index a16b24e01..000000000
--- a/docs/quick_start/quick_start_with_beeline.md
+++ /dev/null
@@ -1,94 +0,0 @@
-<!--
- - Licensed to the Apache Software Foundation (ASF) under one or more
- - contributor license agreements. See the NOTICE file distributed with
- - this work for additional information regarding copyright ownership.
- - The ASF licenses this file to You under the Apache License, Version 2.0
- - (the "License"); you may not use this file except in compliance with
- - the License. You may obtain a copy of the License at
- -
- - http://www.apache.org/licenses/LICENSE-2.0
- -
- - Unless required by applicable law or agreed to in writing, software
- - distributed under the License is distributed on an "AS IS" BASIS,
- - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- - See the License for the specific language governing permissions and
- - limitations under the License.
- -->
-
-
-# Getting Started With Hive Beeline
-
-## Getting Beeline
-
-
-```shell
-
-$ bin/beeline --help
-Usage: java org.apache.hive.cli.beeline.BeeLine
- -u <database url> the JDBC URL to connect to
- -r reconnect to last saved connect url (in
conjunction with !save)
- -n <username> the username to connect as
- -p <password> the password to connect as
- -d <driver class> the driver class to use
- -i <init file> script file for initialization
- -e <query> query that should be executed
- -f <exec file> script file that should be executed
- -w (or) --password-file <password file> the password file to read password
from
- --hiveconf property=value Use value for given property
- --hivevar name=value hive variable name and value
- This is Hive specific settings in which
variables
- can be set at session level and referenced
in Hive
- commands or queries.
- --property-file=<property-file> the file to read connection properties
(url, driver, user, password) from
- --color=[true/false] control whether color is used for display
- --showHeader=[true/false] show column names in query results
- --headerInterval=ROWS; the interval between which heades are
displayed
- --fastConnect=[true/false] skip building table/column list for
tab-completion
- --autoCommit=[true/false] enable/disable automatic transaction commit
- --verbose=[true/false] show verbose error messages and debug info
- --showWarnings=[true/false] display connection warnings
- --showDbInPrompt=[true/false] display the current database name in the
prompt
- --showNestedErrs=[true/false] display nested errors
- --numberFormat=[pattern] format numbers using DecimalFormat pattern
- --force=[true/false] continue running script even after errors
- --maxWidth=MAXWIDTH the maximum width of the terminal
- --maxColumnWidth=MAXCOLWIDTH the maximum width to use when displaying
columns
- --silent=[true/false] be more silent
- --autosave=[true/false] automatically save preferences
- --outputformat=[table/vertical/csv2/tsv2/dsv/csv/tsv] format mode for
result display
- Note that csv, and tsv are deprecated - use
csv2, tsv2 instead
- --incremental=[true/false] Defaults to false. When set to false, the
entire result set
- is fetched and buffered before being
displayed, yielding optimal
- display column sizing. When set to true,
result rows are displayed
- immediately as they are fetched, yielding
lower latency and
- memory usage at the price of extra display
column padding.
- Setting --incremental=true is recommended
if you encounter an OutOfMemory
- on the client side (due to the fetched
result set size being large).
- Only applicable if --outputformat=table.
- --incrementalBufferRows=NUMROWS the number of rows to buffer when printing
rows on stdout,
- defaults to 1000; only applicable if
--incremental=true
- and --outputformat=table
- --truncateTable=[true/false] truncate table column when it exceeds length
- --delimiterForDSV=DELIMITER specify the delimiter for
delimiter-separated values output format (default: |)
- --isolation=LEVEL set the transaction isolation level
- --nullemptystring=[true/false] set to true to get historic behavior of
printing null as empty string
- --maxHistoryRows=MAXHISTORYROWS The maximum number of rows to store beeline
history.
- --help display this message
-
- Example:
- 1. Connect using simple authentication to HiveServer2 on localhost:10000
- $ beeline -u jdbc:hive2://localhost:10000 username password
-
- 2. Connect using simple authentication to HiveServer2 on hs.local:10000
using -n for username and -p for password
- $ beeline -n username -p password -u jdbc:hive2://hs2.local:10012
-
- 3. Connect using Kerberos authentication with hive/[email protected]
as HiveServer2 principal
- $ beeline -u
"jdbc:hive2://hs2.local:10013/default;principal=hive/[email protected]"
-
- 4. Connect using SSL connection to HiveServer2 on localhost at 10000
- $ beeline
"jdbc:hive2://localhost:10000/default;ssl=true;sslTrustStore=/usr/local/truststore;trustStorePassword=mytruststorepassword"
-
- 5. Connect using LDAP authentication
- $ beeline -u jdbc:hive2://hs2.local:10013/default <ldap-username>
<ldap-password>
-
-```
\ No newline at end of file
diff --git a/docs/quick_start/quick_start_with_dbeaver.md
b/docs/quick_start/quick_start_with_dbeaver.md
deleted file mode 100644
index 595089aac..000000000
--- a/docs/quick_start/quick_start_with_dbeaver.md
+++ /dev/null
@@ -1,224 +0,0 @@
-<!--
- - Licensed to the Apache Software Foundation (ASF) under one or more
- - contributor license agreements. See the NOTICE file distributed with
- - this work for additional information regarding copyright ownership.
- - The ASF licenses this file to You under the Apache License, Version 2.0
- - (the "License"); you may not use this file except in compliance with
- - the License. You may obtain a copy of the License at
- -
- - http://www.apache.org/licenses/LICENSE-2.0
- -
- - Unless required by applicable law or agreed to in writing, software
- - distributed under the License is distributed on an "AS IS" BASIS,
- - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- - See the License for the specific language governing permissions and
- - limitations under the License.
- -->
-
-
-# Getting Started With Kyuubi and DBeaver
-
-## What is DBeaver
-
-[DBeaver](https://dbeaver.io/) is a free multi-platform database tool for
developers, database administrators, analysts and all people who need to work
with databases.
-Supports all popular databases as well as our Kyuubi.
-
-Get to know more [About DBeaver](https://github.com/dbeaver/dbeaver/wiki).
-
-## Preparation
-
-### Get DBeaver and Install
-
-Please go to [Download DBeaver](https://dbeaver.io/download/) page to get and
install an appropriate release version for yourself.
-
-### Get Kyuubi Started
-
-[Get the server Started](quick_start.md) first before your try DBeaver with
Kyuubi.
-
-```bash
-Welcome to
- __ __ __
- /\ \/\ \ /\ \ __
- \ \ \/'/' __ __ __ __ __ __\ \ \____/\_\
- \ \ , < /\ \/\ \/\ \/\ \/\ \/\ \\ \ '__`\/\ \
- \ \ \\`\\ \ \_\ \ \ \_\ \ \ \_\ \\ \ \L\ \ \ \
- \ \_\ \_\/`____ \ \____/\ \____/ \ \_,__/\ \_\
- \/_/\/_/`/___/> \/___/ \/___/ \/___/ \/_/
- /\___/
- \/__/
-```
-
-For debugging purpose, you can `tail -f` to track the server log like:
-
-```logtalk
-$ tail -f
/Users/kentyao/Downloads/kyuubi/kyuubi-1.3.0-incubating-bin/logs/kyuubi-kentyao-org.apache.kyuubi.server.KyuubiServer-hulk.local.out
-2021-01-16 03:27:35.449 INFO server.NIOServerCnxnFactory: Accepted socket
connection from /127.0.0.1:65320
-2021-01-16 03:27:35.453 INFO server.ZooKeeperServer: Client attempting to
establish new session at /127.0.0.1:65320
-2021-01-16 03:27:35.455 INFO persistence.FileTxnLog: Creating new log file:
log.1
-2021-01-16 03:27:35.491 INFO server.ZooKeeperServer: Established session
0x177078469840000 with negotiated timeout 60000 for client /127.0.0.1:65320
-2021-01-16 03:27:35.492 INFO zookeeper.ClientCnxn: Session establishment
complete on server 127.0.0.1/127.0.0.1:2181, sessionid = 0x177078469840000,
negotiated timeout = 60000
-2021-01-16 03:27:35.494 INFO state.ConnectionStateManager: State change:
CONNECTED
-2021-01-16 03:27:35.495 INFO client.ServiceDiscovery: Zookeeper client
connection state changed to: CONNECTED
-2021-01-16 03:27:36.516 INFO client.ServiceDiscovery: Created a
/kyuubi/serviceUri=localhost:10009;version=1.0.2;sequence=0000000000 on
ZooKeeper for KyuubiServer uri: localhost:10009
-2021-01-16 03:27:36.516 INFO client.ServiceDiscovery:
Service[ServiceDiscovery] is started.
-2021-01-16 03:27:36.516 INFO server.KyuubiServer: Service[KyuubiServer] is
started.
-```
-
-## Configurations
-### Start DBeaver
-
-If you have successfully installed DBeaver, just hit the button to launch it.
-
-### Select a database
-
-Substantially, this step is to choose a JDBC Driver type to use later.
-We can choose Apache Hive or Apache Spark to set up a driver for Kyuubi,
because they are compatible with the same client.
-
-
-*Tips: zoom up if the pic looks small*
-
-Click next...
-
-### Edit the Driver
-
-We can set libraries that include the `org.apache.hive.jdbc.HiveDriver` and
all of its dependencies.
-
-
-*Tips: zoom up if the pic looks small*
-
-Download/Update it... or,
-
-
-*Tips: zoom up if the pic looks small*
-
-We can configure it by adding a local folder which contains these jars.
-
-### Generic JDBC Connection Settings
-
-To connect to Kyuubi, we should configure the right host and port that starts
the server.
-By default, Kyuubi starts on port `10009` on your localhost.
-
-
-*Tips: zoom up if the pic looks small*
-
-### Other settings
-
-We also can name a recognizable title for this connection.
-
-
-*Tips: zoom up if the pic looks small*
-
-## Interacting With Kyuubi server
-
-### Connections
-
-First, we need to active the connection with Kyuubi server we created in the
above steps.
-
-Correspondingly, the server will help us start an engine, and we will be able
to see a log like below,
-
-```logtalk
-2021-01-16 14:33:56.050 INFO session.KyuubiSessionImpl: Launching SQL engine:
-```
-Once the connection is set up, we shall be able to see the default catalog,
databases(namespaces) as below.
-
-
-
-### Operations
-
-Now, we can use the SQL editor to write queries to interact with Kyuubi server
through the connection.
-
-```sql
-DESC NAMESPACE DEFAULT;
-```
-
-
-```sql
-CREATE TABLE spark_catalog.`default`.SRC(KEY INT, VALUE STRING) USING PARQUET;
-INSERT INTO TABLE spark_catalog.`default`.SRC VALUES (11215016, 'Kent Yao');
-```
-
-*Tips: zoom up if the pic looks small*
-
-```sql
-SELECT KEY % 10 AS ID, SUBSTRING(VALUE, 1, 4) AS NAME FROM
spark_catalog.`default`.SRC;
-```
-
-*Tips: zoom up if the pic looks small*
-
-```sql
-DROP TABLE spark_catalog.`default`.SRC;
-```
-
-## One more case with TPCDS
-
-After we create the TPCDS table in Kyuubi server side, we are able to get all
the database objects, including catalogs, databases, tables, and columns e.t.c.
-
-
-*Tips: zoom up if the pic looks small*
-
-Also, we can use the shortcut key to operating metadata and data, for example.
-
-
-*Tips: zoom up if the pic looks small*
-
-And we can write simple or complex SQL to manipulate data, for example, here
is the query 41 generated by TPCDS `dsqgen` tool.
-
-```sql
-SELECT DISTINCT (i_product_name)
-FROM item i1
-WHERE i_manufact_id BETWEEN 738 AND 738 + 40
- AND (SELECT count(*) AS item_cnt
-FROM item
-WHERE (i_manufact = i1.i_manufact AND
- ((i_category = 'Women' AND
- (i_color = 'powder' OR i_color = 'khaki') AND
- (i_units = 'Ounce' OR i_units = 'Oz') AND
- (i_size = 'medium' OR i_size = 'extra large')
- ) OR
- (i_category = 'Women' AND
- (i_color = 'brown' OR i_color = 'honeydew') AND
- (i_units = 'Bunch' OR i_units = 'Ton') AND
- (i_size = 'N/A' OR i_size = 'small')
- ) OR
- (i_category = 'Men' AND
- (i_color = 'floral' OR i_color = 'deep') AND
- (i_units = 'N/A' OR i_units = 'Dozen') AND
- (i_size = 'petite' OR i_size = 'large')
- ) OR
- (i_category = 'Men' AND
- (i_color = 'light' OR i_color = 'cornflower') AND
- (i_units = 'Box' OR i_units = 'Pound') AND
- (i_size = 'medium' OR i_size = 'extra large')
- ))) OR
- (i_manufact = i1.i_manufact AND
- ((i_category = 'Women' AND
- (i_color = 'midnight' OR i_color = 'snow') AND
- (i_units = 'Pallet' OR i_units = 'Gross') AND
- (i_size = 'medium' OR i_size = 'extra large')
- ) OR
- (i_category = 'Women' AND
- (i_color = 'cyan' OR i_color = 'papaya') AND
- (i_units = 'Cup' OR i_units = 'Dram') AND
- (i_size = 'N/A' OR i_size = 'small')
- ) OR
- (i_category = 'Men' AND
- (i_color = 'orange' OR i_color = 'frosted') AND
- (i_units = 'Each' OR i_units = 'Tbl') AND
- (i_size = 'petite' OR i_size = 'large')
- ) OR
- (i_category = 'Men' AND
- (i_color = 'forest' OR i_color = 'ghost') AND
- (i_units = 'Lb' OR i_units = 'Bundle') AND
- (i_size = 'medium' OR i_size = 'extra large')
- )))) > 0
-ORDER BY i_product_name
-LIMIT 100
-```
-
-
-*Tips: zoom up if the pic looks small*
-
-## Epilogue
-
-There are many other amazing features in both Kyuubi and DBeaver and here is
just the tip of the iceberg.
-The rest is for you to discover.
