pingcap/tikv

TiKV 镜像文档

!https://github.com/tikv/tikv/raw/master/images/tikv-logo.png

镜像概述和主要用途

TiKV 是一个开源、分布式、事务性的键值数据库。与其他传统 NoSQL 系统不同，TiKV 不仅提供经典的键值 API，还提供符合 ACID 标准的事务 API。TiKV 采用 Rust 语言开发，并由 Raft 协议提供支持，最初由 PingCAP 创建，用于补充 https://github.com/pingcap/tidb%E2%80%94%E2%80%94%E4%B8%80%E4%B8%AA%E5%85%BC%E5%AE%B9 MySQL 协议的分布式 HTAP 数据库。

TiKV（"Ti" 代表钛）的设计灵感来源于 Google 的一些优秀分布式系统，如 BigTable、Spanner 和 Percolator，以及近年来学术界的一些最新成果，如 Raft 共识算法。

TiKV 是 Cloud Native Computing Foundation (CNCF) 的毕业项目。

!https://github.com/tikv/tikv/raw/master/images/cncf-white.png#gh-light-mode-only

核心功能和特性

TiKV 通过 Rust 实现的 Raft 共识算法以及存储在 RocksDB 中的共识状态，保证了数据一致性。引入的 Placement Driver (PD) 实现了自动分片，支持数据自动迁移。事务模型借鉴了 Google 的 Percolator 并进行了一些性能改进。TiKV 还提供快照隔离 (SI)、带锁的快照隔离（SQL: SELECT ... FOR UPDATE）以及分布式事务中的外部一致性读写。

主要特性

• 地理复制：使用 Raft 和 Placement Driver 支持地理复制
• 水平扩展性：借助 PD 和精心设计的 Raft 组，TiKV 具有出色的水平扩展性，可以轻松扩展到 100+ TB 的数据
• 一致性分布式事务：类似于 Google 的 Spanner，支持外部一致的分布式事务
• 协处理器支持：类似于 HBase，实现了协处理器框架以支持分布式计算
• 与 TiDB 协作：通过内部优化，TiKV 和 TiDB 可以协同工作，形成一个具有高水平扩展性、外部一致事务、支持 RDBMS 和 NoSQL 设计模式的数据库解决方案

使用场景和适用范围

TiKV 适用于需要高可用性、强一致性和水平扩展能力的分布式存储场景，主要包括：

• 作为 TiDB 数据库的分布式存储引擎
• 需要 ACID 事务支持的分布式键值存储场景
• 需要水平扩展能力的大规模数据存储
• 云原生环境下的分布式数据存储需求
• 需要地理复制功能的多区域部署场景

TiKV 软件栈

!https://github.com/tikv/tikv/raw/master/images/tikv_stack.png

• Placement Driver (PD)：TiKV 的集群管理器，定期检查复制约束以自动平衡负载和数据
• Store：每个 Store 中包含一个 RocksDB，用于将数据存储到本地磁盘
• Region：键值数据移动的基本单位，每个 Region 被复制到多个节点，这些多个副本形成一个 Raft 组
• Node：集群中的物理节点，每个节点包含一个或多个 Store，每个 Store 包含多个 Region

当节点启动时，Node、Store 和 Region 的元数据被记录到 PD 中。每个 Region 和 Store 的状态定期报告给 PD。

使用方法和配置说明

使用 TiUP 部署 playground

使用 TiDB 尝试 TiKV 最快的方法是使用 TiUP，这是 TiDB 的组件管理器。

详细步骤请参见 官方文档。

使用二进制部署 playground

TiKV 能够与 PD 一起单独运行，这是最小化部署要求。

1. 下载并提取二进制文件

bash
$ export TIKV_VERSION=v7.5.0
$ export GOOS=darwin  # 仅支持 {darwin, linux}
$ export GOARCH=amd64 # 仅支持 {amd64, arm64}
$ curl -O  https://tiup-mirrors.pingcap.com/tikv-$TIKV_VERSION-$GOOS-$GOARCH.tar.gz
$ curl -O  https://tiup-mirrors.pingcap.com/pd-$TIKV_VERSION-$GOOS-$GOARCH.tar.gz
$ tar -xzf tikv-$TIKV_VERSION-$GOOS-$GOARCH.tar.gz
$ tar -xzf pd-$TIKV_VERSION-$GOOS-$GOARCH.tar.gz

2. 启动 PD 实例

bash
$ ./pd-server --name=pd --data-dir=/tmp/pd/data --client-urls="http://127.0.0.1:2379" --peer-urls="http://127.0.0.1:2380" --initial-cluster="pd=http://127.0.0.1:2380" --log-file=/tmp/pd/log/pd.log

3. 启动 TiKV 实例

bash
$ ./tikv-server --pd-endpoints="127.0.0.1:2379" --addr="127.0.0.1:20160" --data-dir=/tmp/tikv/data --log-file=/tmp/tikv/log/tikv.log

4. 安装 TiKV 客户端(Python)并验证部署，需要 Python 3.5+

bash
$ pip3 install -i https://test.pypi.org/simple/ tikv-client

python
from tikv_client import RawClient

client = RawClient.connect("127.0.0.1:2379")

client.put(b'foo', b'bar')
print(client.get(b'foo')) # b'bar'

client.put(b'foo', b'baz')
print(client.get(b'foo')) # b'baz'

使用 Docker 部署

单节点部署

bash
# 启动 PD 容器
docker run -d --name pd -p 2379:2379 -p 2380:2380 pingcap/pd:latest \
  --name=pd \
  --data-dir=/data \
  --client-urls="http://0.0.0.0:2379" \
  --peer-urls="http://0.0.0.0:2380" \
  --initial-cluster="pd=http://0.0.0.0:2380"

# 启动 TiKV 容器
docker run -d --name tikv -p 20160:20160 --link pd:pd pingcap/tikv:latest \
  --pd-endpoints="pd:2379" \
  --addr="0.0.0.0:20160" \
  --data-dir=/data

Docker Compose 部署

创建 docker-compose.yml 文件：

yaml
version: '3'

services:
  pd:
    image: pingcap/pd:latest
    ports:
      - "2379:2379"
      - "2380:2380"
    volumes:
      - ./pd/data:/data
      - ./pd/log:/log
    command:
      - --name=pd
      - --data-dir=/data
      - --client-urls=http://0.0.0.0:2379
      - --peer-urls=http://0.0.0.0:2380
      - --initial-cluster=pd=http://0.0.0.0:2380
      - --log-file=/log/pd.log

  tikv:
    image: pingcap/tikv:latest
    ports:
      - "20160:20160"
    volumes:
      - ./tikv/data:/data
      - ./tikv/log:/log
    command:
      - --pd-endpoints=pd:2379
      - --addr=0.0.0.0:20160
      - --data-dir=/data
      - --log-file=/log/tikv.log
    depends_on:
      - pd

启动服务：

bash
docker-compose up -d

配置参数说明

PD 主要配置参数

TiKV 主要配置参数

客户端驱动

• https://github.com/tikv/client-go (最稳定且广泛使用)
• https://github.com/tikv/client-java
• https://github.com/tikv/client-rust
• https://github.com/tikv/client-c

如欲尝试 Go 客户端，请参见 Go Client 文档。

安全

安全审计

第三方安全审计由 Cure53 执行。完整报告参见 https://github.com/tikv/tikv/blob/master/security/Security-Audit.pdf%E3%80%82

报告安全漏洞

如要报告安全漏洞，请发送电子邮件至 TiKV-security 组。

有关 TiKV 项目遵循的流程和政策，请参见 https://github.com/tikv/tikv/blob/master/SECURITY.md%E3%80%82

社区和支持

社交媒体

• ---

• 博客
• Reddit
• 在 Stack Overflow 上提问或回答问题

Slack

加入 TiKV 社区 Slack - 注册并加入您感兴趣的 TiKV 主题频道。

许可证

TiKV 使用 Apache 2.0 许可证。详情参见 https://github.com/tikv/tikv/blob/master/LICENSE 文件。