tispark

(β˜… 889)

TiSpark is built for running Apache Spark on top of TiDB/TiKV

  • .gitignore
  • .gitmodules
  • .lift.toml
  • .travis.yml
  • CHANGELOG.md
  • docker-compose-4.0.yaml
  • docker-compose-TiDB-TLS.yaml
  • docker-compose.yaml
  • LICENSE
  • OWNERS
  • pom.xml
  • README.md

πŸš€ Installation Guide

1. Get the code
git clone https://github.com/pingcap/tispark

Downloads the entire project code from GitHub to your computer.

cd tispark

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Maven (Java)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java projects.
  • Maven The build tool used for the mvn command.
cd assembly

This project's files live in a subfolder, so move into it first.

mvn clean install

Installs dependencies and builds the project using Maven.

βœ… A BUILD SUCCESS message means it worked. The output is created under target/.

4. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
cd tikv-client

This project's files live in a subfolder, so move into it first.

make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation