wangzhigang1999 commented on code in PR #7744:
URL: https://github.com/apache/kyuubi/pull/7744#discussion_r4056408926


##########
docs/connector/spark/tpch.md:
##########
@@ -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.
+-->
+
+# TPC-H
+
+The TPC-H is a decision support benchmark. It consists of a suite of business
+oriented ad-hoc queries and concurrent data modifications. The queries and the
+data populating the database have been chosen to have broad industry-wide
+relevance.
+
+```{tip}
+This article assumes that you have mastered the basic knowledge and operation 
of TPC-H.
+For the knowledge about TPC-H not mentioned in this article, you can obtain it 
from its [Official Documentation](https://www.tpc.org/tpch/).
+```
+
+This connector can be used to test the capabilities and query syntax of Spark 
without configuring access to an external data source.
+When you query a TPC-H table, the connector generates the data on the fly 
using a deterministic algorithm.
+
+Goto [Try Kyuubi](https://try.kyuubi.cloud/) to explore TPC-H data instantly!
+
+## TPC-H Integration
+
+To enable the integration of Kyuubi Spark SQL engine and TPC-H through Spark 
DataSource V2 API, you need to:
+
+- Referencing the TPC-H connector [dependencies](#dependencies)
+- Setting the Spark catalog [configurations](#configurations)
+
+### Dependencies
+
+The **classpath** of Kyuubi Spark SQL engine with TPC-H supported consists of:
+
+1. kyuubi-spark-sql-engine-{{ release }}_2.12.jar, the engine jar deployed 
with a Kyuubi distribution
+2. A copy of Spark distribution
+3. `kyuubi-spark-connector-tpch-<release>_2.12.jar`, which can be found in the 
[Maven 
Central](https://repo1.maven.org/maven2/org/apache/kyuubi/kyuubi-spark-connector-tpch_2.12/)

Review Comment:
   Could we preserve {{ release }} here and in the spark.jars example below, as 
in tpcds.md? The [1.12.0 
documentation](https://kyuubi.readthedocs.io/en/v1.12.0/connector/spark/tpch.html#dependencies)
 renders the matching version in both places. Keeping the substitution would 
preserve this behavior after the format migration.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to