This is an automated email from the ASF dual-hosted git repository.
chengpan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/kyuubi.git
The following commit(s) were added to refs/heads/master by this push:
new bb3e06a03 [KYUUBI #4312] [DOCS] Include `**/README.md` in markdown
style check
bb3e06a03 is described below
commit bb3e06a035d76c4bc9448e5430fbdaa31f8c74ed
Author: liangbowen <[email protected]>
AuthorDate: Tue Feb 14 02:23:32 2023 +0800
[KYUUBI #4312] [DOCS] Include `**/README.md` in markdown style check
### _Why are the changes needed?_
- Include `**/README.md` markdown files in spotless style check
### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including
negative and positive cases if possible
- [ ] Add screenshots for manual tests if appropriate
- [x] [Run
test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests)
locally before make a pull request
Closes #4312 from bowenliang123/reformat-readme.
Closes #4312
1fda1bdeb [Bowen Liang] Merge branch 'master' into reformat-readme
2ca8b4c81 [liangbowen] merge master
876f52a4c [liangbowen] include `**/README.md` in spotless style check
Lead-authored-by: liangbowen <[email protected]>
Co-authored-by: Bowen Liang <[email protected]>
Signed-off-by: Cheng Pan <[email protected]>
---
README.md | 41 ++++++++-----------
dev/kyuubi-tpcds/README.md | 53 +++++++++++++------------
docker/playground/README.md | 3 +-
extensions/README.md | 36 ++++++++---------
extensions/spark/kyuubi-spark-authz/README.md | 32 +++++++--------
extensions/spark/kyuubi-spark-lineage/README.md | 33 +++++++--------
kyuubi-hive-beeline/README.md | 1 +
kyuubi-hive-jdbc/README.md | 2 +-
kyuubi-server/web-ui/README.md | 2 +-
pom.xml | 1 +
10 files changed, 101 insertions(+), 103 deletions(-)
diff --git a/README.md b/README.md
index 0b46abf85..e54f6fac0 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,19 @@
<!--
- - 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.
- -->
+- 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.
+-->
<p align="center">
<img
src="https://svn.apache.org/repos/asf/comdev/project-logos/originals/kyuubi-1.svg";
alt="Kyuubi logo" height="120px"/>
@@ -45,6 +45,7 @@
</p>
# Apache Kyuubi
+
Apache Kyuubi™ is a distributed and multi-tenant gateway to provide serverless
SQL on data warehouses and lakehouses.
@@ -60,12 +61,10 @@ Kyuubi provides a pure SQL gateway through Thrift JDBC/ODBC
interface for end-us
- [x] Multi-tenant Spark Support
- [x] Running Spark in a serverless way
-
### Target Users
Kyuubi's goal is to make it easy and efficient for `anyone` to use Spark(maybe
other engines soon) and facilitate users to handle big data like ordinary data.
Here, `anyone` means that users do not need to have a Spark technical
background but a human language, SQL only. Sometimes, SQL skills are
unnecessary when integrating Kyuubi with Apache Superset, which supports rich
visualizations and dashboards.
-
In typical big data production environments with Kyuubi, there should be
system administrators and end-users.
- System administrators: A small group consists of Spark experts responsible
for Kyuubi deployment, configuration, and tuning.
@@ -73,7 +72,6 @@ In typical big data production environments with Kyuubi,
there should be system
Additionally, the Kyuubi community will continuously optimize the whole system
with various features, such as History-Based Optimizer, Auto-tuning,
Materialized View, SQL Dialects, Functions, e.t.c.
-
### Usage scenarios
#### Port workloads from HiveServer2 to Spark SQL
@@ -86,7 +84,6 @@ HiveServer2 can identify and authenticate a caller, and then
if the caller also
Kyuubi extends the use of STS in a multi-tenant model based on a unified
interface and relies on the concept of multi-tenancy to interact with cluster
managers to finally gain the ability of resources sharing/isolation and data
security. The loosely coupled architecture of the Kyuubi server and engine
dramatically improves the client concurrency and service stability of the
service itself.
-
#### DataLake/LakeHouse Support
The vision of Kyuubi is to unify the portal and become an easy-to-use data
lake management platform. Different kinds of workloads, such as ETL processing
and BI analytics, can be supported by one platform, using one copy of data,
with one SQL interface.
@@ -95,25 +92,19 @@ The vision of Kyuubi is to unify the portal and become an
easy-to-use data lake
- Multiple Catalogs support
- SQL Standard Authorization support for DataLake(coming)
-
#### Cloud Native Support
Kyuubi can deploy its engines on different kinds of Cluster Managers, such as,
Hadoop YARN, Kubernetes, etc.
-
-
### The Kyuubi Ecosystem(present and future)
-
The figure below shows our vision for the Kyuubi Ecosystem. Some of them have
been realized, some in development,
and others would not be possible without your help.
-
-
## Online Documentation
Since Kyuubi 1.3.0-incubating, the Kyuubi online documentation is hosted by
[https://kyuubi.apache.org/](https://kyuubi.apache.org/).
diff --git a/dev/kyuubi-tpcds/README.md b/dev/kyuubi-tpcds/README.md
index adffb6726..a9a6487aa 100644
--- a/dev/kyuubi-tpcds/README.md
+++ b/dev/kyuubi-tpcds/README.md
@@ -1,21 +1,22 @@
<!--
- - 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.
- -->
+- 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.
+-->
# Introduction
+
This module includes TPC-DS data generator and benchmark tool.
# How to use
@@ -27,12 +28,12 @@ package jar with following command:
Support options:
-| key | default | description |
-|--------------|-----------------|-----------------------------------|
-| db | default | the database to write data |
-| scaleFactor | 1 | the scale factor of TPC-DS |
-| format | parquet | the format of table to store data |
-| parallel | scaleFactor * 2 | the parallelism of Spark job |
+| key | default | description |
+|-------------|-----------------|-----------------------------------|
+| db | default | the database to write data |
+| scaleFactor | 1 | the scale factor of TPC-DS |
+| format | parquet | the format of table to store data |
+| parallel | scaleFactor * 2 | the parallelism of Spark job |
Example: the following command to generate 10GB data with new database
`tpcds_sf10`.
@@ -47,7 +48,7 @@ $SPARK_HOME/bin/spark-submit \
Support options:
-| key | default | description
|
+| key | default | description
|
|-------------|------------------------|---------------------------------------------------------------|
| db | none(required) | the TPC-DS database
|
| benchmark | tpcds-v2.4-benchmark | the name of application
|
@@ -65,6 +66,7 @@ $SPARK_HOME/bin/spark-submit \
```
We also support run one of the TPC-DS query:
+
```shell
$SPARK_HOME/bin/spark-submit \
--class org.apache.kyuubi.tpcds.benchmark.RunBenchmark \
@@ -73,6 +75,7 @@ $SPARK_HOME/bin/spark-submit \
The result of TPC-DS benchmark like:
-| name | minTimeMs | maxTimeMs | avgTimeMs | stdDev | stdDevPercent |
-|---------|-----------|-------------|------------|----------|----------------|
-| q1-v2.4 | 50.522384 | 868.010383 | 323.398267 | 471.6482 | 145.8413108576 |
+| name | minTimeMs | maxTimeMs | avgTimeMs | stdDev | stdDevPercent |
+|---------|-----------|------------|------------|----------|----------------|
+| q1-v2.4 | 50.522384 | 868.010383 | 323.398267 | 471.6482 | 145.8413108576 |
+
diff --git a/docker/playground/README.md b/docker/playground/README.md
index d9e227c2c..66dca2af0 100644
--- a/docker/playground/README.md
+++ b/docker/playground/README.md
@@ -1,5 +1,5 @@
Playground
-===
+==========
## For Users
@@ -45,3 +45,4 @@ Kyuubi supply some built-in dataset, after Kyuubi started,
you can run the follo
1. Build images `docker/playground/build-image.sh`;
2. Optional to use `buildx` to build and publish cross-platform images
`BUILDX=1 docker/playground/build-image.sh`;
+
diff --git a/extensions/README.md b/extensions/README.md
index 92eac9097..5725f0f9b 100644
--- a/extensions/README.md
+++ b/extensions/README.md
@@ -1,25 +1,24 @@
<!--
- - 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.
- -->
-
+- 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.
+-->
+
# For developers
This folder contains plugins/extension for kyuubi server and different engine
types.
-
- ext
- kyuubi-server
- spark
@@ -27,4 +26,5 @@ This folder contains plugins/extension for kyuubi server and
different engine ty
- trino
- hive
- others
- - ...
\ No newline at end of file
+ - ...
+
diff --git a/extensions/spark/kyuubi-spark-authz/README.md
b/extensions/spark/kyuubi-spark-authz/README.md
index c257e30e1..554797ee0 100644
--- a/extensions/spark/kyuubi-spark-authz/README.md
+++ b/extensions/spark/kyuubi-spark-authz/README.md
@@ -1,19 +1,19 @@
<!--
- - 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.
- -->
+- 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 Spark AuthZ Extension
@@ -29,7 +29,6 @@
build/mvn clean package -pl :kyuubi-spark-authz_2.12 -Dspark.version=3.2.1
-Dranger.version=2.3.0
```
-
### Supported Apache Spark Versions
`-Dspark.version=`
@@ -54,3 +53,4 @@ build/mvn clean package -pl :kyuubi-spark-authz_2.12
-Dspark.version=3.2.1 -Dran
- [x] 1.0.x
- [x] 0.7.x
- [x] 0.6.x
+
diff --git a/extensions/spark/kyuubi-spark-lineage/README.md
b/extensions/spark/kyuubi-spark-lineage/README.md
index e70acc015..34f2733b4 100644
--- a/extensions/spark/kyuubi-spark-lineage/README.md
+++ b/extensions/spark/kyuubi-spark-lineage/README.md
@@ -1,26 +1,26 @@
<!--
- - 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.
- -->
+- 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 Spark Listener Extension
## Functions
- [x] All `listener` extensions can be implemented in this module, like
`QueryExecutionListener` and `ExtraListener`
-- [x] Add `SparkOperationLineageQueryExecutionListener` to extends spark
`QueryExecutionListener`
+- [x] Add `SparkOperationLineageQueryExecutionListener` to extends spark
`QueryExecutionListener`
- [x] SQL lineage parsing will be triggered after SQL execution and will be
written to the json logger file
## Build
@@ -37,3 +37,4 @@ build/mvn clean package -pl :kyuubi-spark-lineage_2.12
-Dspark.version=3.2.1
- [x] 3.3.x (default)
- [x] 3.2.x
- [x] 3.1.x
+
diff --git a/kyuubi-hive-beeline/README.md b/kyuubi-hive-beeline/README.md
index ec4f86fd7..161acb99b 100644
--- a/kyuubi-hive-beeline/README.md
+++ b/kyuubi-hive-beeline/README.md
@@ -3,3 +3,4 @@
Aiming to make a better supported beeline for Kyuubi
- Support to show launch engine log when getting KyuubiConnection(Done,
available since v1.4.0-incubating)
+
diff --git a/kyuubi-hive-jdbc/README.md b/kyuubi-hive-jdbc/README.md
index 3210e76ac..10a0522dc 100644
--- a/kyuubi-hive-jdbc/README.md
+++ b/kyuubi-hive-jdbc/README.md
@@ -1,9 +1,9 @@
# Kyuubi Hive JDBC Module
-
Aiming to make a better supported client for Kyuubi and Spark
- Add catalog to getTables meta function for DataLakes (DONE, broken in
v1.3.0-incubating, fixed in v1.3.1-incubating)
- Deploy to maven central (DONE, available since v1.3.0-incubating)
- Create shaded jar (DONE, available since v1.4.0-incubating)
- Remove Hive dependencies (DONE, available since v1.6.0-incubating)
+
diff --git a/kyuubi-server/web-ui/README.md b/kyuubi-server/web-ui/README.md
index cc5654b23..6d808ecde 100644
--- a/kyuubi-server/web-ui/README.md
+++ b/kyuubi-server/web-ui/README.md
@@ -17,7 +17,6 @@ npm install
To do this you can change the VITE_APP_DEV_WEB_URL parameter variable as the
service url in `.env.development` in the project root directory, such as
http://127.0. 0.1:8090
-
```shell
npm run dev
```
@@ -56,3 +55,4 @@ pnpm run build
# Code Format
pnpm run prettier
```
+
diff --git a/pom.xml b/pom.xml
index 06fba720d..8bffc4f8b 100644
--- a/pom.xml
+++ b/pom.xml
@@ -2076,6 +2076,7 @@
</python>
<markdown>
<includes>
+ <include>**/README.md</include>
<include>docs/**/*.md</include>
</includes>
<flexmark>
![https://svn.apache.org/repos/asf/comdev/project-logos/originals/kyuubi-1.svg"](https://svn.apache.org/repos/asf/comdev/project-logos/originals/kyuubi-1.svg"){kind=link}