diff --git a/docs/integrations/index.rst b/docs/connector/flink/index.rst similarity index 89% rename from docs/integrations/index.rst rename to docs/connector/flink/index.rst index 095815d5b..52873389d 100644 --- a/docs/integrations/index.rst +++ b/docs/connector/flink/index.rst @@ -13,12 +13,8 @@ See the License for the specific language governing permissions and limitations under the License. -Integrations -=========================== +Connectors For Flink SQL Query Engine +===================================== .. toctree:: :maxdepth: 2 - - kudu - delta_lake - delta_lake_with_azure_blob diff --git a/docs/connector/hive/index.rst b/docs/connector/hive/index.rst new file mode 100644 index 000000000..dddfd5ce6 --- /dev/null +++ b/docs/connector/hive/index.rst @@ -0,0 +1,20 @@ +.. 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. + +Connectors for Hive SQL Query Engine +==================================== + +.. toctree:: + :maxdepth: 2 diff --git a/docs/connector/index.rst b/docs/connector/index.rst new file mode 100644 index 000000000..b04aa878b --- /dev/null +++ b/docs/connector/index.rst @@ -0,0 +1,37 @@ +.. 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. + +Connectors +========== + +This section describes the connectors available for different kyuubi engines to access data from various data sources. + +.. note:: Is your connector missing? + `Report an feature request `_ or help us document it. + +.. toctree:: + :maxdepth: 2 + + spark/index + +.. toctree:: + :maxdepth: 2 + + flink/index + +.. toctree:: + :maxdepth: 2 + + hive/index diff --git a/docs/connector/spark/delta_lake.rst b/docs/connector/spark/delta_lake.rst new file mode 100644 index 000000000..3fed1a62d --- /dev/null +++ b/docs/connector/spark/delta_lake.rst @@ -0,0 +1,95 @@ +.. 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. + +`Delta Lake`_ +============= + +Delta lake is an open-source project that enables building a Lakehouse +Architecture on top of existing storage systems such as S3, ADLS, GCS, +and HDFS. + +.. tip:: + This article assumes that you have mastered the basic knowledge and + operation of `Delta Lake`_. + For the knowledge about delta lake not mentioned in this article, + you can obtain it from its `Official Documentation`_. + +By using kyuubi, we can run SQL queries towards delta lake which is more +convenient, easy to understand, and easy to expand than directly using +spark to manipulate delta lake. + +Delta Lake Integration +---------------------- + +To enable the integration of kyuubi spark sql engine and delta lake through +Apache Spark Datasource V2 and Catalog APIs, you need to: + +- Referencing the delta lake :ref:`dependencies` +- Setting the spark extension and catalog :ref:`configurations` + +.. _dependencies: + +Dependencies +************ + +The **classpath** of kyuubi spark sql engine with delta lake supported consists of + +1. kyuubi-spark-sql-engine-|release|.jar, the engine jar deployed with kyuubi distributions +2. a copy of spark distribution +3. delta-core & delta-storage, which can be found in the `Maven Central`_ + +In order to make the delta packages visible for the runtime classpath of engines, we can use one of these methods: + +1. Put the delta packages into ``$SPARK_HOME/jars`` directly +2. Set ``spark.jars=/path/to/delta-core,/path/to/delta-storage`` + +.. warning:: + Please mind the compatibility of different Delta Lake and Spark versions, which can be confirmed on the page of `delta release notes`_. + +.. _configurations: + +Configurations +************** + +To activate functionality of delta lake, we can set the following configurations: + +.. code-block:: properties + + spark.sql.extensions=io.delta.sql.DeltaSparkSessionExtension + spark.sql.catalog.spark_catalog=org.apache.spark.sql.delta.catalog.DeltaCatalog + +Delta Lake Operations +--------------------- + +As for end-users, who only use a pure SQL interface, there aren't much differences between +using a delta table and a regular hive table. Unless you are going to use some advanced +features, but they are still SQL, just more syntax added. + +Taking ``CREATE A TABLE`` as a example, + +.. code-block:: sql + + CREATE TABLE IF NOT EXISTS kyuubi_delta ( + id INT, + name STRING, + org STRING, + url STRING, + start TIMESTAMP + ) USING DELTA; + +.. _Delta Lake: https://delta.io/ +.. _Official Documentation: https://docs.delta.io/latest/index.html +.. _Maven Central: https://mvnrepository.com/artifact/io.delta/delta-core +.. _Delta release notes: https://github.com/delta-io/delta/releases \ No newline at end of file diff --git a/docs/connector/spark/delta_lake_with_azure_blob.rst b/docs/connector/spark/delta_lake_with_azure_blob.rst new file mode 100644 index 000000000..dd302c5fd --- /dev/null +++ b/docs/connector/spark/delta_lake_with_azure_blob.rst @@ -0,0 +1,345 @@ +.. 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. + +Delta Lake with Microsoft Azure Blob Storage +============================================ + +Registration And Configuration +---------------------------------------------- + +Register An Account And Log In +****************************** + +Regarding the Microsoft Azure account, please contact your organization or register +an account as an individual. For details, please refer to the `Microsoft Azure official +website`_. + +Create Storage Container +************************ + +After logging in with your Microsoft Azure account, please follow the steps below to create a data storage container: + +.. image:: ../../imgs/deltalake/azure_create_new_container.png + +Get Access Key +************** + +.. image:: ../../imgs/deltalake/azure_create_azure_access_key.png + +Deploy Spark +------------ + +Download Spark Package +********************** + +Download spark package that matches your environment from `spark official website`_. +And then unpackage: +```shell +tar -xzvf spark-3.2.0-bin-hadoop3.2.tgz +``` + +Config Spark +************ + +Enter the ``$SPARK_HOME/conf`` directory and execute: + +.. code-block:: shell + + cp spark-defaults.conf.template spark-defaults.conf + +Add following configuration to spark-defaults.conf, please refer to your own local configuration for specific personalized configuration: + +.. code-block:: properties + + spark.master spark://:7077 + spark.sql.extensions io.delta.sql.DeltaSparkSessionExtension + spark.sql.catalog.spark_catalog org.apache.spark.sql.delta.catalog.DeltaCatalog + +Create a new file named ``core-site.xml`` under ``$SPARK_HOME/conf`` directory, and add following configuration: + +.. code-block:: xml + + + + + + fs.AbstractFileSystem.wasb.Impl + org.apache.hadoop.fs.azure.Wasb + + + fs.azure.account.key.YOUR_AZURE_ACCOUNT.blob.core.windows.net + YOUR_AZURE_ACCOUNT_ACCESS_KEY + + + fs.azure.block.blob.with.compaction.dir + /hbase/WALs,/tmp/myblobfiles + + + fs.azure + org.apache.hadoop.fs.azure.NativeAzureFileSystem + + + fs.azure.enable.append.support + true + + + + +Copy Dependencies To Spark +************************** + +Copy jar packages required by delta lake and microsoft azure to ./spark/jars directory: + +.. code-block:: shell + + wget https://repo1.maven.org/maven2/io/delta/delta-core_2.12/1.0.0/delta-core_2.12-1.0.0.jar -O ./spark/jars/delta-core_2.12-1.0.0.jar + wget https://repo1.maven.org/maven2/com/microsoft/azure/azure-storage/8.6.6/azure-storage-8.6.6.jar -O ./spark/jars/azure-storage-8.6.6.jar + wget https://repo1.maven.org/maven2/com/azure/azure-storage-blob/12.14.2/azure-storage-blob-12.14.2.jar -O ./spark/jars/azure-storage-blob-12.14.2.jar + wget https://repo1.maven.org/maven2/org/apache/hadoop/hadoop-azure/3.1.1/hadoop-azure-3.1.1.jar -O ./spark/jars/hadoop-azure-3.1.1.jar + +Start Spark Standalone cluster +****************************** + +.. code-block:: shell + + ./spark/sbin/start-master.sh -h -p 7077 --webui-port 9090 + ./spark/sbin/start-worker.sh spark://:7077 + +Test The connectivity Of Spark And Delta Lake +********************************************* + +Start spark shell: + +.. code-block:: shell + + ./bin/spark-shell + +Generate a piece of random data and push them to delta lake: + +.. code-block:: scala + + scala> val data = spark.range(1000, 2000) + scala> data.write.format("delta").mode("overwrite").save("wasbs://@.blob.core.windows.net/") + +After this, you can check your data on azure web UI. For example, my container name is 1000 and table name is alexDemo20211127: + +.. image:: ../../imgs/deltalake/azure_spark_connection_test_storage.png + +You can also check data by reading back the data from delta lake: + +.. code-block:: scala + + scala> val df=spark.read.format("delta").load("wasbs://@.blob.core.windows.net/") + scala> df.show() + +If there is no problem with the above, it proves that spark has been built with delta lake. + +Deploy Kyuubi +------------- + +Install Kyuubi +************** + +1.Download the latest version of kyuubi from `kyuubi download page`_. + +2.Unpackage + + tar -xzvf apache-kyuubi-|release|-incubating-bin.tgz + +Config Kyuubi +************* + +Enter the ./kyuubi/conf directory + +.. code-block:: shell + + cp kyuubi-defaults.conf.template kyuubi-defaults.conf + vim kyuubi-defaults.conf + +Add the following content: + +.. code-block:: properties + spark.master spark://:7077 + kyuubi.authentication NONE + kyuubi.frontend.bind.host + kyuubi.frontend.bind.port 10009 + # If you use your own zk cluster, you need to configure your zk host port. + # kyuubi.ha.zookeeper.quorum :2181 + +Start Kyuubi +************ + +.. code-block:: shell + + bin/kyuubi start + +Check kyuubi log, in order to check kyuubi start status and find the jdbc connection url: + +.. code-block:: log + + 2021-11-26 17:49:50.235 INFO service.ThriftFrontendService: Starting and exposing JDBC connection at: jdbc:hive2://HOST:10009/ + 2021-11-26 17:49:50.265 INFO client.ServiceDiscovery: Created a /kyuubi/serviceUri=host:10009;version=1.3.1-incubating;sequence=0000000037 on ZooKeeper for KyuubiServer uri: host:10009 + 2021-11-26 17:49:50.267 INFO server.KyuubiServer: Service[KyuubiServer] is started. + +You can get the jdbc connection url by the log above. + +Test The Connectivity Of Kyuubi And Delta Lake +********************************************** + +Use ``$KYUUBI_HOME/bin/beeline`` tool, + +.. code-block:: shell + + ./bin//beeline -u 'jdbc:hive2://:10009/' + +At the same time, you can also check whether the engine is running on the spark UI: + +.. image:: ../../imgs/deltalake/kyuubi_start_status_spark_UI.png + +When the engine started, it will expose a thrift endpoint and register itself into ZooKeeper, Kyuubi server can get the connection info from ZooKeeper and establish the connection to the engine. +So, you can check the registration details in zookeeper path '/kyuubi_USER/anonymous'. + +Dealing Delta Lake Data By Using Kyuubi Examples +------------------------------------------------ + +Operate delta-lake data through SQL: + +Create Table +************ + +.. code-block:: sql + -- Create or replace table with path + CREATE OR REPLACE TABLE delta.`wasbs://1000@azure_account.blob.core.windows.net/alexDemo20211129` ( + date DATE, + eventId STRING, + eventType STRING, + data STRING) + USING DELTA + PARTITIONED BY (date); + +Insert Data +*********** + +Append Mode +^^^^^^^^^^^ + +.. code-block:: sql + + INSERT INTO delta.`wasbs://1000@azure_account.blob.core.windows.net/alexDemo20211129` ( + date, + eventId, + eventType, + data) + VALUES + (now(),'001','test','Hello World!'), + (now(),'002','test','Hello World!'), + (now(),'003','test','Hello World!'); + +Result: + +.. code-block:: text + + +-------------+----------+------------+---------------+ + | date | eventId | eventType | data | + +-------------+----------+------------+---------------+ + | 2021-11-29 | 001 | test | Hello World! | + | 2021-11-29 | 003 | test | Hello World! | + | 2021-11-29 | 002 | test | Hello World! | + +-------------+----------+------------+---------------+ + +Overwrite Mode +^^^^^^^^^^^^^^ + +.. code-block:: sql + + INSERT OVERWRITE TABLE delta.`wasbs://1000@azure_account.blob.core.windows.net/alexDemo20211129`( + date, + eventId, + eventType, + data) + VALUES + (now(),'001','test','hello kyuubi'), + (now(),'002','test','hello kyuubi'); + +Result: + +.. code-block:: text + +-------------+----------+------------+---------------+ + | date | eventId | eventType | data | + +-------------+----------+------------+---------------+ + | 2021-11-29 | 002 | test | hello kyuubi | + | 2021-11-29 | 001 | test | hello kyuubi | + +-------------+----------+------------+---------------+ + +Delete Table Data +***************** + +.. code-block:: sql + DELETE FROM + delta.`wasbs://1000@azure_account.blob.core.windows.net/alexDemo20211129` + WHERE eventId = 002; + +Result: + +.. code-block:: text + + +-------------+----------+------------+---------------+ + | date | eventId | eventType | data | + +-------------+----------+------------+---------------+ + | 2021-11-29 | 001 | test | hello kyuubi | + +-------------+----------+------------+---------------+ + +Update table data +***************** + +.. code-block:: sql + + UPDATE + delta.`wasbs://1000@azure_account.blob.core.windows.net/alexDemo20211129` + SET data = 'This is a test for update data.' + WHERE eventId = 001; + +Result: + +.. code-block:: text + + +-------------+----------+------------+----------------------------------+ + | date | eventId | eventType | data | + +-------------+----------+------------+----------------------------------+ + | 2021-11-29 | 001 | test | This is a test for update data. | + +-------------+----------+------------+----------------------------------+ + +Select table data +***************** + +.. code-block:: sql + + SELECT * + FROM + delta.`wasbs://1000@azure_account.blob.core.windows.net/alexDemo20211129`; + +Result: + +.. code-block:: text + + +-------------+----------+------------+----------------------------------+ + | date | eventId | eventType | data | + +-------------+----------+------------+----------------------------------+ + | 2021-11-29 | 001 | test | This is a test for update data. | + +-------------+----------+------------+----------------------------------+ + +.. _Microsoft Azure official website: https://azure.microsoft.com/en-gb/ +.. _spark official website: https://spark.apache.org/downloads.html +.. _kyuubi download page: https://kyuubi.apache.org/releases.html diff --git a/docs/connector/spark/hudi.rst b/docs/connector/spark/hudi.rst new file mode 100644 index 000000000..a004c911c --- /dev/null +++ b/docs/connector/spark/hudi.rst @@ -0,0 +1,36 @@ +.. 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. + +`Hudi`_ +======== + +Hudi Integration +---------------- + +.. _dependencies: + +Dependencies +************ + +.. _configurations: + +Configurations +************** + + +Hudi Operations +--------------- + +.. _Hudi: https://hudi.apache.org/ \ No newline at end of file diff --git a/docs/connector/spark/iceberg.rst b/docs/connector/spark/iceberg.rst new file mode 100644 index 000000000..c23cd55ee --- /dev/null +++ b/docs/connector/spark/iceberg.rst @@ -0,0 +1,37 @@ +.. 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. + +`Iceberg`_ +========== + + +Iceberg Integration +------------------- + +.. _dependencies: + +Dependencies +************ + +.. _configurations: + +Configurations +************** + + +Iceberg Operations +------------------ + +.. _Iceberg: https://iceberg.apache.org/ \ No newline at end of file diff --git a/docs/connector/spark/index.rst b/docs/connector/spark/index.rst new file mode 100644 index 000000000..d0ecd5451 --- /dev/null +++ b/docs/connector/spark/index.rst @@ -0,0 +1,41 @@ +.. 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. + +Connectors for Spark SQL Query Engine +===================================== + +The Kyuubi Spark SQL Query Engine uses Spark DataSource APIs(V1/V2) to access +data from different data sources. + +By default, it provides accessibility to hive warehouses with various file formats +supported, such as parquet, orc, json, etc. + +Also，it can easily integrate with other third-party libraries, such as Hudi, +Iceberg, Delta Lake, Kudu, HBase，Cassandra, etc. + +We also provide sample data sources like TDC-DS, TPC-H for testing and benchmarking +purpose. + +.. toctree:: + :maxdepth: 2 + + delta_lake + delta_lake_with_azure_blob + hudi + iceberg + kudu + tispark + tpcds + tpch diff --git a/docs/integrations/kudu.md b/docs/connector/spark/kudu.md similarity index 99% rename from docs/integrations/kudu.md rename to docs/connector/spark/kudu.md index 860009c23..0d3c850d7 100644 --- a/docs/integrations/kudu.md +++ b/docs/connector/spark/kudu.md @@ -15,7 +15,7 @@ - limitations under the License. --> -# Kyuubi On Apache Kudu +# Kudu ## What is Apache Kudu diff --git a/docs/connector/spark/tispark.rst b/docs/connector/spark/tispark.rst new file mode 100644 index 000000000..12fb276b1 --- /dev/null +++ b/docs/connector/spark/tispark.rst @@ -0,0 +1,36 @@ +.. 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. + +`TiSpark`_ +========== + +TiSpark Integration +------------------- + +.. _dependencies: + +Dependencies +************ + +.. _configurations: + +Configurations +************** + + +TiSpark Operations +------------------ + +.. _TiSpark: https://docs.pingcap.com/tidb/dev/tispark-overview \ No newline at end of file diff --git a/docs/connector/spark/tpch.rst b/docs/connector/spark/tpch.rst new file mode 100644 index 000000000..31ae5c92a --- /dev/null +++ b/docs/connector/spark/tpch.rst @@ -0,0 +1,34 @@ +.. 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. + +TPC-H +===== + +TPC-DS Integration +------------------ + +.. _dependencies: + +Dependencies +************ + +.. _configurations: + +Configurations +************** + + +TPC-H Operations +---------------- diff --git a/docs/connector/spark/tpdcs.rst b/docs/connector/spark/tpdcs.rst new file mode 100644 index 000000000..ed110ae8f --- /dev/null +++ b/docs/connector/spark/tpdcs.rst @@ -0,0 +1,34 @@ +.. 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. + +TPC-DS +===== + +TPC-DS Integration +------------------- + +.. _dependencies: + +Dependencies +************ + +.. _configurations: + +Configurations +************** + + +TPC-DS Operations +------------------ diff --git a/docs/imgs/deltalake/delta_lake_functions.png b/docs/imgs/deltalake/delta_lake_functions.png deleted file mode 100644 index 015e5b698..000000000 Binary files a/docs/imgs/deltalake/delta_lake_functions.png and /dev/null differ diff --git a/docs/index.rst b/docs/index.rst index 8f565abc6..b697b6f06 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -93,19 +93,31 @@ High Availability Kyuubi provides both high availability and load balancing solutions based on Zookeeper. .. toctree:: - :caption: Usage Guide + :caption: Admin Guide :maxdepth: 2 :glob: quick_start/index deployment/index Security - client/index - integrations/index monitor/index - sql/index tools/index +.. toctree:: + :caption: User Guide + :maxdepth: 2 + :glob: + + Clients & APIs + SQL References + +.. toctree:: + :caption: Connectors + :maxdepth: 2 + :glob: + + connector/index + .. toctree:: :caption: Kyuubi Insider :maxdepth: 2 diff --git a/docs/integrations/delta_lake.md b/docs/integrations/delta_lake.md deleted file mode 100644 index eb82fb80e..000000000 --- a/docs/integrations/delta_lake.md +++ /dev/null @@ -1,33 +0,0 @@ - - -# Kyuubi On Delta Lake - -## What is Delta Lake - -> Delta lake is an open-source project that enables building a Lakehouse Architecture on top of existing storage systems such as S3, ADLS, GCS, and HDFS. - -![](../imgs/deltalake/delta_lake_functions.png) -This article assumes that you have mastered the basic knowledge and operation of [Delta Lake](https://delta.io/). -For the knowledge about delta lake not mentioned in this article, you can obtain it from its [official documentation](https://docs.delta.io/latest/index.html). - -## Why Kyuubi on Delta Lake -As we know, Kyuubi provides a pure SQL gateway through Thrift JDBC/ODBC interface for end-users to manipulate large-scale data with pre-programmed and extensible Spark SQL engines. By using kyuubi, we can run SQL queries towards delta lake which is more convenient, easy to understand, and easy to expand than directly using spark to manipulate delta lake. - -## References -- [https://delta.io/](https://delta.io/) - diff --git a/docs/integrations/delta_lake_with_azure_blob.md b/docs/integrations/delta_lake_with_azure_blob.md deleted file mode 100644 index dfd60b835..000000000 --- a/docs/integrations/delta_lake_with_azure_blob.md +++ /dev/null @@ -1,356 +0,0 @@ - - -# Kyuubi On Delta Lake With Microsoft Azure Blob Storage - -## Microsoft Azure Registration And Configuration -#### Register A Microsoft Azure Account And Log In -Regarding the Microsoft Azure account, please contact your organization or register an account as an individual. For details, please refer to the [Microsoft Azure official website](https://azure.microsoft.com/en-gb/). - -#### Create Microsoft Azure Storage Container -After logging in with your Microsoft Azure account, please follow the steps below to create a data storage container: -![](../imgs/deltalake/azure_create_new_container.png) - -#### Get Microsoft Azure Access Key -![](../imgs/deltalake/azure_create_azure_access_key.png) - -## Deploy Spark -#### Download Spark Package -Download spark package that matches your environment from [spark official website](https://spark.apache.org/downloads.html). And then unpackage: -```shell -tar -xzvf spark-3.2.0-bin-hadoop3.2.tgz -``` - -#### Config Spark -Enter the ./spark/conf directory and execute: -```shell -cp spark-defaults.conf.tmp spark-defaults.conf -``` - -Add following configuration to spark-defaults.conf, please refer to your own local configuration for specific personalized configuration: -```text -spark.master spark://:7077 -spark.sql.extensions io.delta.sql.DeltaSparkSessionExtension -spark.sql.catalog.spark_catalog org.apache.spark.sql.delta.catalog.DeltaCatalog -``` -Create a new file named core-site.xml under ./spark/conf directory, and add following configuration: -```xml - - - - - fs.AbstractFileSystem.wasb.Impl - org.apache.hadoop.fs.azure.Wasb - - - fs.azure.account.key.YOUR_AZURE_ACCOUNT.blob.core.windows.net - YOUR_AZURE_ACCOUNT_ACCESS_KEY - - - fs.azure.block.blob.with.compaction.dir - /hbase/WALs,/tmp/myblobfiles - - - fs.azure - org.apache.hadoop.fs.azure.NativeAzureFileSystem - - - fs.azure.enable.append.support - true - - -``` -#### Copy Dependencies To Spark -Copy jar packages required by delta lake and microsoft azure to ./spark/jars directory: -```shell -wget https://repo1.maven.org/maven2/io/delta/delta-core_2.12/1.0.0/delta-core_2.12-1.0.0.jar -O ./spark/jars/delta-core_2.12-1.0.0.jar - -wget https://repo1.maven.org/maven2/com/microsoft/azure/azure-storage/8.6.6/azure-storage-8.6.6.jar -O ./spark/jars/azure-storage-8.6.6.jar - -wget https://repo1.maven.org/maven2/com/azure/azure-storage-blob/12.14.2/azure-storage-blob-12.14.2.jar -O ./spark/jars/azure-storage-blob-12.14.2.jar - -wget https://repo1.maven.org/maven2/org/apache/hadoop/hadoop-azure/3.1.1/hadoop-azure-3.1.1.jar -O ./spark/jars/hadoop-azure-3.1.1.jar -``` -#### Start Spark -```shell -./spark/sbin/start-master.sh -h -p 7077 --webui-port 9090 - -./spark/sbin/start-worker.sh spark://:7077 -``` - -#### Test The connectivity Of Spark And Delta Lake -Start spark shell: -```shell -/usr/apache/current/spark/bin> ./spark-shell -Using Spark's default log4j profile: org/apache/spark/log4j-defaults.properties -Setting default log level to "WARN". -To adjust logging level use sc.setLogLevel(newLevel). For SparkR, use setLogLevel(newLevel). -Spark context Web UI available at http://HOST:4040 -Spark context available as 'sc' (master = spark://HOST:7077, app id = app-20211126172803-0003). -Spark session available as 'spark'. -Welcome to - ____ __ - / __/__ ___ _____/ /__ - _\ \/ _ \/ _ `/ __/ '_/ - /___/ .__/\_,_/_/ /_/\_\ version 3.1.2 - /_/ - -Using Scala version 2.12.10 (OpenJDK 64-Bit Server VM, Java 1.8.0_302) -Type in expressions to have them evaluated. -Type :help for more information. - -scala> - -``` -Generate a piece of random data and push them to delta lake: -```shell -scala> val data = spark.range(1000, 2000) -scala> data.write.format("delta").mode("overwrite").save("wasbs://@.blob.core.windows.net/") -``` -After this, you can check your data on azure web UI. For example, my container name is 1000 and table name is alexDemo20211127: -![](../imgs/deltalake/azure_spark_connection_test_storage.png) - -You can also check data by reading back the data from delta lake: -```shell -scala> val df=spark.read.format("delta").load("wasbs://@.blob.core.windows.net/") -scala> df.show() -+----+ -| id| -+----+ -|1000| -|1001| -|1002| -|1003| -|1004| -|1005| -|1006| -|1007| -|1008| -|1009| -|1010| -|1011| -|1012| -|1013| -|1014| -|1015| -|1016| -|1017| -|1018| -|1019| -+----+ -only showing top 20 rows -``` -If there is no problem with the above, it proves that spark has been built with delta lake. - -## Deploy Kyuubi -#### Install Kyuubi -1.Download the latest version of [kyuubi](https://kyuubi.apache.org/releases.html). - -2.Unpackage -```shell -tar -xzvf apache-kyuubi-1.3.1-incubating-bin.tgz -``` -#### Config Kyuubi -Enter the ./kyuubi/conf directory -```shell -cp kyuubi-defaults.conf.template kyuubi-defaults.conf -vim kyuubi-defaults.conf -``` - -Add the following content: -```text -spark.master spark://:7077 -kyuubi.authentication NONE -kyuubi.frontend.bind.host -kyuubi.frontend.bind.port 10009 -# If you use your own zk cluster, you need to configure your zk host port. -# kyuubi.ha.zookeeper.quorum :2181 -``` - -#### Start Kyuubi -```shell -/usr/apache/current/kyuubi/bin> kyuubi start -Starting Kyuubi Server from /usr/apache/current/kyuubi -Warn: Not find kyuubi environment file /usr/apache/current/kyuubi/conf/kyuubi-env.sh, using default ones... -JAVA_HOME: /usr/lib64/jvm/java -KYUUBI_HOME: /usr/apache/current/kyuubi -KYUUBI_CONF_DIR: /usr/apache/current/kyuubi/conf -KYUUBI_LOG_DIR: /usr/apache/current/kyuubi/logs -KYUUBI_PID_DIR: /usr/apache/current/kyuubi/pid -KYUUBI_WORK_DIR_ROOT: /usr/apache/current/kyuubi/work -SPARK_HOME: /usr/apache/current/spark -SPARK_CONF_DIR: /usr/apache/current/spark/conf -HADOOP_CONF_DIR: -YARN_CONF_DIR: -Starting org.apache.kyuubi.server.KyuubiServer, logging to /usr/apache/current/kyuubi/logs/kyuubi-hadoop-org.apache.kyuubi.server.KyuubiServer-host.out -Welcome to - __ __ __ - /\ \/\ \ /\ \ __ - \ \ \/'/' __ __ __ __ __ __\ \ \____/\_\ - \ \ , < /\ \/\ \/\ \/\ \/\ \/\ \\ \ '__`\/\ \ - \ \ \\`\\ \ \_\ \ \ \_\ \ \ \_\ \\ \ \L\ \ \ \ - \ \_\ \_\/`____ \ \____/\ \____/ \ \_,__/\ \_\ - \/_/\/_/`/___/> \/___/ \/___/ \/___/ \/_/ - /\___/ - \/__/ -``` - -Check kyuubi log, in order to check kyuubi start status and find the jdbc connection url: -```shell -2021-11-26 17:49:50.227 INFO server.KyuubiServer: Service[KyuubiServer] is initialized. -2021-11-26 17:49:50.229 INFO service.KinitAuxiliaryService: Service[KinitAuxiliaryService] is started. -2021-11-26 17:49:50.230 INFO metrics.JsonReporterService: Service[JsonReporterService] is started. -2021-11-26 17:49:50.230 INFO metrics.MetricsSystem: Service[MetricsSystem] is started. -2021-11-26 17:49:50.234 INFO zookeeper.ClientCnxn: Socket connection established to host/*.*.*.*:2181, initiating session -2021-11-26 17:49:50.234 INFO operation.KyuubiOperationManager: Service[KyuubiOperationManager] is started. -2021-11-26 17:49:50.234 INFO session.KyuubiSessionManager: Service[KyuubiSessionManager] is started. -2021-11-26 17:49:50.234 INFO server.KyuubiBackendService: Service[KyuubiBackendService] is started. -2021-11-26 17:49:50.235 INFO service.ThriftFrontendService: Service[ThriftFrontendService] is started. -2021-11-26 17:49:50.235 INFO service.ThriftFrontendService: Starting and exposing JDBC connection at: jdbc:hive2://HOST:10009/ -2021-11-26 17:49:50.239 INFO zookeeper.ClientCnxn: Session establishment complete on server host/*.*.*.*:2181, sessionid = 0x100046ec0ca01b5, negotiated timeout = 40000 -2021-11-26 17:49:50.245 INFO state.ConnectionStateManager: State change: CONNECTED -2021-11-26 17:49:50.247 INFO client.KyuubiServiceDiscovery: Zookeeper client connection state changed to: CONNECTED -2021-11-26 17:49:50.265 INFO client.ServiceDiscovery: Created a /kyuubi/serviceUri=host:10009;version=1.3.1-incubating;sequence=0000000037 on ZooKeeper for KyuubiServer uri: host:10009 -2021-11-26 17:49:50.266 INFO client.KyuubiServiceDiscovery: Service[KyuubiServiceDiscovery] is started. -2021-11-26 17:49:50.267 INFO server.KyuubiServer: Service[KyuubiServer] is started. -``` -You can get the jdbc connection url by the log: -```shell -2021-11-26 17:49:50.235 INFO service.ThriftFrontendService: Starting and exposing JDBC connection at: jdbc:hive2://HOST:10009/ -``` -#### Test The Connectivity Of Kyuubi And Delta Lake -```shell -/usr/apache/current/spark/bin> ./beeline -u 'jdbc:hive2://:10009/' -log4j:WARN No appenders could be found for logger (org.apache.hadoop.util.Shell). -log4j:WARN Please initialize the log4j system properly. -log4j:WARN See http://logging.apache.org/log4j/1.2/faq.html#noconfig for more info. -Connecting to jdbc:hive2://HOST:10009/ -Connected to: Spark SQL (version 1.3.1-incubating) -Driver: Hive JDBC (version 2.3.7) -Transaction isolation: TRANSACTION_REPEATABLE_READ -Beeline version 2.3.7 by Apache Hive -0: jdbc:hive2://YOUR_HOST> -``` -At the same time, you can also check whether the engine is running on the spark UI: -![](../imgs/deltalake/kyuubi_start_status_spark_UI.png) - -When the engine started, it will expose a thrift endpoint and register itself into ZooKeeper, Kyuubi server can get the connection info from ZooKeeper and establish the connection to the engine. -So, you can check the registration details in zookeeper path ’/kyuubi_USER/anonymous‘. - -## Dealing Delta Lake Data By Using Kyuubi Examples -Operate delta-lake data through SQL: -1.Create Table -```sql --- Create or replace table with path -CREATE OR REPLACE TABLE delta.`wasbs://1000@azure_account.blob.core.windows.net/alexDemo20211129` ( - date DATE, - eventId STRING, - eventType STRING, - data STRING) -USING DELTA -PARTITIONED BY (date); -``` -2.Insert Data -Append Mode: -```sql -INSERT INTO delta.`wasbs://1000@azure_account.blob.core.windows.net/alexDemo20211129` ( - date, - eventId, - eventType, - data) -VALUES - (now(),'001','test','Hello World!'), - (now(),'002','test','Hello World!'), - (now(),'003','test','Hello World!'); -``` -Result: -```shell -+-------------+----------+------------+---------------+ -| date | eventId | eventType | data | -+-------------+----------+------------+---------------+ -| 2021-11-29 | 001 | test | Hello World! | -| 2021-11-29 | 003 | test | Hello World! | -| 2021-11-29 | 002 | test | Hello World! | -+-------------+----------+------------+---------------+ -``` -Overwrite Mode: -```sql -INSERT OVERWRITE TABLE delta.`wasbs://1000@azure_account.blob.core.windows.net/alexDemo20211129`( - date, - eventId, - eventType, - data) -VALUES -(now(),'001','test','hello kyuubi'), -(now(),'002','test','hello kyuubi'); -``` -Result: -```shell -+-------------+----------+------------+---------------+ -| date | eventId | eventType | data | -+-------------+----------+------------+---------------+ -| 2021-11-29 | 002 | test | hello kyuubi | -| 2021-11-29 | 001 | test | hello kyuubi | -+-------------+----------+------------+---------------+ -``` -Delete Table Data: -```sql -delete from delta.`wasbs://1000@azure_account.blob.core.windows.net/alexDemo20211129` where eventId = 002; -``` -Result: -```shell -+-------------+----------+------------+---------------+ -| date | eventId | eventType | data | -+-------------+----------+------------+---------------+ -| 2021-11-29 | 001 | test | hello kyuubi | -+-------------+----------+------------+---------------+ -``` - -Update table data: -```sql -UPDATE delta.`wasbs://1000@azure_account.blob.core.windows.net/alexDemo20211129` -SET data = 'This is a test for update data.' -WHERE eventId = 001; -``` -Result: -```text -+-------------+----------+------------+----------------------------------+ -| date | eventId | eventType | data | -+-------------+----------+------------+----------------------------------+ -| 2021-11-29 | 001 | test | This is a test for update data. | -+-------------+----------+------------+----------------------------------+ -``` - -Select table data: -```sql -SELECT * FROM delta.`wasbs://1000@azure_account.blob.core.windows.net/alexDemo20211129`; -``` -Result: -```text -+-------------+----------+------------+----------------------------------+ -| date | eventId | eventType | data | -+-------------+----------+------------+----------------------------------+ -| 2021-11-29 | 001 | test | This is a test for update data. | -+-------------+----------+------------+----------------------------------+ -``` - -## References -- [https://delta.io/](https://delta.io/) -- [https://docs.delta.io/latest/delta-batch.html#-ddlcreatetable](https://docs.delta.io/latest/delta-batch.html#-ddlcreatetable) -- [https://spark.apache.org/docs/latest/](https://spark.apache.org/docs/latest/) -- [https://docs.microsoft.com/en-us/azure/databricks/delta/quick-start](https://docs.microsoft.com/en-us/azure/databricks/delta/quick-start) -