Skip to content

Commit 7fa347d

Browse files
authored
TiSpark: highlight compatibility and restructure overview (#21705) (#21710)
1 parent 3409461 commit 7fa347d

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

tispark-overview.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,10 @@ summary: Use TiSpark to provide an HTAP solution to serve as a one-stop solution
55

66
# TiSpark User Guide
77

8-
![TiSpark architecture](/media/tispark-architecture.png)
9-
10-
## TiSpark vs TiFlash
11-
12-
[TiSpark](https://github.com/pingcap/tispark) is a thin layer built for running Apache Spark on top of TiDB/TiKV to answer the complex OLAP queries. It takes advantages of both the Spark platform and the distributed TiKV cluster and seamlessly glues to TiDB, the distributed OLTP database, to provide a Hybrid Transactional/Analytical Processing (HTAP) solution to serve as a one-stop solution for both online transactions and analysis.
13-
14-
[TiFlash](/tiflash/tiflash-overview.md) is another tool that enables HTAP. Both TiFlash and TiSpark allow the use of multiple hosts to execute OLAP queries on OLTP data. TiFlash stores data in a columnar format, which allows more efficient analytical queries. TiFlash and TiSpark can be used together.
15-
16-
## What is TiSpark
8+
> **Warning:**
9+
>
10+
> - TiSpark does not guarantee compatibility with TiDB v7.0.0 and later versions.
11+
> - TiSpark does not guarantee compatibility with Spark v3.4.0 and later versions.
1712
1813
TiSpark depends on the TiKV cluster and the PD cluster. You also need to set up a Spark cluster. This document provides a brief introduction to how to setup and use TiSpark. It requires some basic knowledge of Apache Spark. For more information, see [Apache Spark website](https://spark.apache.org/docs/latest/index.html).
1914

@@ -33,6 +28,16 @@ Also, TiSpark supports distributed writes to TiKV. Compared with writes to TiDB
3328
>
3429
> Because TiSpark accesses TiKV directly, the access control mechanisms used by TiDB Server are not applicable to TiSpark. Since TiSpark v2.5.0, TiSpark supports user authentication and authorization, for more information, see [Security](/tispark-overview.md#security).
3530
31+
The following diagram shows the architecture of TiSpark.
32+
33+
![TiSpark architecture](/media/tispark-architecture.png)
34+
35+
## TiSpark vs TiFlash
36+
37+
[TiSpark](https://github.com/pingcap/tispark) is a thin layer built for running Apache Spark on top of TiDB/TiKV to answer complex OLAP queries. It takes advantage of both the Spark platform and the distributed TiKV cluster and seamlessly integrates with TiDB, the distributed OLTP database, to provide a Hybrid Transactional/Analytical Processing (HTAP) solution to serve as a one-stop solution for both online transactions and analysis.
38+
39+
[TiFlash](/tiflash/tiflash-overview.md) is another tool that enables HTAP. Both TiFlash and TiSpark allow the use of multiple hosts to execute OLAP queries on OLTP data. TiFlash stores data in a columnar format, which allows more efficient analytical queries. TiFlash and TiSpark can be used together.
40+
3641
## Requirements
3742

3843
+ TiSpark supports Spark >= 2.3.
@@ -101,11 +106,6 @@ You can choose TiSpark version according to your TiDB and Spark version.
101106

102107
TiSpark 2.4.4, 2.5.3, 3.0.3, 3.1.7, and 3.2.3 are the latest stable versions and are highly recommended.
103108

104-
> **Note:**
105-
>
106-
> TiSpark does not guarantee compatibility with TiDB v7.0.0 and later versions.
107-
> TiSpark does not guarantee compatibility with Spark v3.4.0 and later versions.
108-
109109
### Get TiSpark jar
110110

111111
You can get the TiSpark jar using one of the following methods:

0 commit comments

Comments
 (0)