Skip to content

Commit

Permalink
Update README.md (pingcap#1581)
Browse files Browse the repository at this point in the history
  • Loading branch information
tisonkun authored Mar 18, 2021
1 parent 8f0b7ef commit 0829f34
Showing 1 changed file with 60 additions and 5 deletions.
65 changes: 60 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,63 @@
# ClickHouse
ClickHouse is an open-source column-oriented database management system that allows generating analytical data reports in real time.
# TiFlash

🎤🥂 **ClickHouse Meetup in [Sunnyvale](https://www.meetup.com/San-Francisco-Bay-Area-ClickHouse-Meetup/events/248898966/) & [San Francisco](https://www.meetup.com/San-Francisco-Bay-Area-ClickHouse-Meetup/events/249162518/), April 23-27** 🍰🔥🐻
## Building TiFlash

Learn more about ClickHouse at [https://clickhouse.yandex/](https://clickhouse.yandex/)
### Prerequisites

[![Build Status](https://travis-ci.org/yandex/ClickHouse.svg?branch=master)](https://travis-ci.org/yandex/ClickHouse)
- CMake 3.13.2+

### Setup Compiler

- (macOS) Apple Clang 12.0.0
- (CentOS) GCC 7.3.0

### Install gRPC Systemwise(skip if already have protoc 3.8.x and gRPC 1.26.0 installed)

**You'd better remove any other `protoc` installation except 3.8.x to get a clean build.**

You should use exact gRPC 1.26.0. Refer to gRPC [document](https://github.com/grpc/grpc/blob/master/BUILDING.md) or our test settings [example](https://github.com/pingcap/kvproto/blob/master/.github/workflows/cpp-test.yaml) for how to do it.

### Checkout Source Code

```
# WORKSPACE
$ git clone --recursive https://github.com/pingcap/tics.git
```

### Generate Protos

```
# WORKSPACE/tics
$ pushd contrib/kvproto
$ ./scripts/generate_cpp.sh
$ popd
$ pushd contrib/tipb
$ ./generate-cpp.sh
$ popd
```

### Build tiflash-proxy

```
# WORKSPACE/tics
$ pushd contrib/tiflash-proxy
$ make release
$ popd
$ mkdir -p libs/libtiflash-proxy
$ cp contrib/tiflash-proxy/target/release/libtiflash_proxy* libs/libtiflash-proxy
```

### Build TiFlash

```
# WORKSPACE/tics
$ rm -rf build
$ mkdir -p build
$ pushd build
$ cmake .. -DCMAKE_BUILD_TYPE=Debug -DENABLE_TESTS=1 # default build type: RELWITHDEBINFO
$ make tiflash
$ popd
```

Now you will get TiFlash binary under `WORKSPACE/tics/build/dbms/src/Server/tiflash`.

0 comments on commit 0829f34

Please sign in to comment.