├── content ├── blog │ ├── _index.md │ ├── zelda.png │ ├── rupees.png │ ├── TiKV-Security-Audit.pdf │ └── tikv-community-connections.md ├── docs │ ├── 3.0 │ │ ├── tasks │ │ │ ├── backup │ │ │ │ └── introduction.md │ │ │ ├── try │ │ │ │ └── introduction.md │ │ │ ├── deploy │ │ │ │ ├── introduction.md │ │ │ │ └── docker-compose.md │ │ │ ├── monitor │ │ │ │ └── introduction.md │ │ │ └── configure │ │ │ │ └── introduction.md │ │ ├── concepts │ │ │ └── features.md │ │ ├── releases │ │ │ └── introduction.md │ │ └── reference │ │ │ ├── introduction.md │ │ │ ├── tools │ │ │ ├── pd-server.md │ │ │ ├── tikv-server.md │ │ │ └── introduction.md │ │ │ ├── clients │ │ │ ├── introduction.md │ │ │ ├── java.md │ │ │ └── c.md │ │ │ └── query-layers.md │ ├── 4.0 │ │ ├── tasks │ │ │ ├── backup │ │ │ │ └── introduction.md │ │ │ ├── try │ │ │ │ └── introduction.md │ │ │ ├── deploy │ │ │ │ ├── introduction.md │ │ │ │ └── docker-compose.md │ │ │ ├── monitor │ │ │ │ └── introduction.md │ │ │ └── configure │ │ │ │ ├── coprocessor.md │ │ │ │ ├── storage.md │ │ │ │ ├── grpc.md │ │ │ │ └── introduction.md │ │ ├── concepts │ │ │ └── features.md │ │ ├── releases │ │ │ ├── introduction.md │ │ │ └── 4.0.0-rc.md │ │ └── reference │ │ │ ├── introduction.md │ │ │ ├── tools │ │ │ ├── pd-server.md │ │ │ ├── tikv-server.md │ │ │ └── introduction.md │ │ │ ├── clients │ │ │ ├── introduction.md │ │ │ ├── java.md │ │ │ └── c.md │ │ │ └── query-layers.md │ ├── dev │ │ ├── new-features │ │ │ └── overview.md │ │ ├── deploy │ │ │ ├── configure │ │ │ │ ├── grpc.md │ │ │ │ ├── storage.md │ │ │ │ ├── raftstore.md │ │ │ │ ├── coprocessor.md │ │ │ │ ├── rocksdb.md │ │ │ │ └── introduction.md │ │ │ ├── performance │ │ │ │ └── performance.md │ │ │ ├── install │ │ │ │ └── install.md │ │ │ ├── operate │ │ │ │ └── operate.md │ │ │ └── monitor │ │ │ │ ├── monitor.md │ │ │ │ └── framework.md │ │ ├── reference │ │ │ ├── introduction.md │ │ │ ├── TiUP.md │ │ │ ├── CLI │ │ │ │ └── introduction.md │ │ │ ├── architecture │ │ │ │ └── introduction.md │ │ │ └── query-layers.md │ │ ├── develop │ │ │ ├── clients │ │ │ │ ├── cpp.md │ │ │ │ └── python.md │ │ │ ├── rawkv │ │ │ │ └── introduction.md │ │ │ └── develop.md │ │ └── concepts │ │ │ └── whats-next.md │ ├── 5.1 │ │ ├── deploy │ │ │ ├── configure │ │ │ │ ├── storage.md │ │ │ │ ├── grpc.md │ │ │ │ ├── raftstore.md │ │ │ │ ├── coprocessor.md │ │ │ │ ├── rocksdb.md │ │ │ │ ├── introduction.md │ │ │ │ └── region-merge.md │ │ │ ├── performance │ │ │ │ └── performance.md │ │ │ ├── install │ │ │ │ └── install.md │ │ │ ├── operate │ │ │ │ └── operate.md │ │ │ └── monitor │ │ │ │ ├── monitor.md │ │ │ │ └── framework.md │ │ ├── reference │ │ │ ├── introduction.md │ │ │ ├── TiUP.md │ │ │ ├── CLI │ │ │ │ └── introduction.md │ │ │ ├── architecture │ │ │ │ └── introduction.md │ │ │ └── query-layers.md │ │ ├── develop │ │ │ ├── clients │ │ │ │ ├── go.md │ │ │ │ ├── cpp.md │ │ │ │ └── python.md │ │ │ ├── rawkv │ │ │ │ └── introduction.md │ │ │ └── develop.md │ │ └── concepts │ │ │ └── whats-next.md │ ├── 6.1 │ │ ├── deploy │ │ │ ├── configure │ │ │ │ ├── grpc.md │ │ │ │ ├── storage.md │ │ │ │ ├── raftstore.md │ │ │ │ ├── coprocessor.md │ │ │ │ ├── rocksdb.md │ │ │ │ └── introduction.md │ │ │ ├── performance │ │ │ │ └── performance.md │ │ │ ├── install │ │ │ │ └── install.md │ │ │ ├── operate │ │ │ │ └── operate.md │ │ │ └── monitor │ │ │ │ ├── monitor.md │ │ │ │ └── framework.md │ │ ├── reference │ │ │ ├── introduction.md │ │ │ ├── TiUP.md │ │ │ ├── CLI │ │ │ │ └── introduction.md │ │ │ ├── architecture │ │ │ │ └── introduction.md │ │ │ └── query-layers.md │ │ ├── develop │ │ │ ├── rawkv │ │ │ │ └── introduction.md │ │ │ ├── clients │ │ │ │ ├── cpp.md │ │ │ │ └── python.md │ │ │ └── develop.md │ │ └── concepts │ │ │ └── whats-next.md │ ├── 6.5 │ │ ├── deploy │ │ │ ├── configure │ │ │ │ ├── grpc.md │ │ │ │ ├── storage.md │ │ │ │ ├── raftstore.md │ │ │ │ ├── coprocessor.md │ │ │ │ ├── rocksdb.md │ │ │ │ └── introduction.md │ │ │ ├── performance │ │ │ │ └── performance.md │ │ │ ├── install │ │ │ │ └── install.md │ │ │ ├── operate │ │ │ │ └── operate.md │ │ │ └── monitor │ │ │ │ ├── monitor.md │ │ │ │ └── framework.md │ │ ├── reference │ │ │ ├── introduction.md │ │ │ ├── TiUP.md │ │ │ ├── CLI │ │ │ │ └── introduction.md │ │ │ ├── architecture │ │ │ │ └── introduction.md │ │ │ └── query-layers.md │ │ ├── develop │ │ │ ├── clients │ │ │ │ ├── cpp.md │ │ │ │ └── python.md │ │ │ ├── rawkv │ │ │ │ └── introduction.md │ │ │ └── develop.md │ │ └── concepts │ │ │ └── whats-next.md │ └── 7.1 │ │ ├── deploy │ │ ├── configure │ │ │ ├── grpc.md │ │ │ ├── storage.md │ │ │ ├── raftstore.md │ │ │ ├── coprocessor.md │ │ │ ├── rocksdb.md │ │ │ └── introduction.md │ │ ├── performance │ │ │ └── performance.md │ │ ├── install │ │ │ └── install.md │ │ ├── operate │ │ │ └── operate.md │ │ └── monitor │ │ │ ├── monitor.md │ │ │ └── framework.md │ │ ├── reference │ │ ├── introduction.md │ │ ├── TiUP.md │ │ ├── CLI │ │ │ └── introduction.md │ │ ├── architecture │ │ │ └── introduction.md │ │ └── query-layers.md │ │ ├── develop │ │ ├── clients │ │ │ ├── cpp.md │ │ │ └── python.md │ │ ├── rawkv │ │ │ └── introduction.md │ │ └── develop.md │ │ └── concepts │ │ └── whats-next.md ├── deep-dive │ ├── testing │ │ └── failure_injection.md │ ├── resource-scheduling │ │ └── introduction.md │ ├── scalability │ │ └── introduction.md │ ├── distributed-transaction │ │ └── introduction.md │ ├── key-value-engine │ │ └── introduction.md │ └── consensus-algorithm │ │ └── introduction.md └── community │ ├── sig-engine.md │ ├── sig-raft.md │ ├── sig-coprocessor.md │ ├── sig-scheduling.md │ └── sig-transaction.md ├── static ├── favicon.png ├── img │ ├── logos │ │ ├── card.png │ │ ├── cncf-color.png │ │ ├── icon │ │ │ ├── black │ │ │ │ ├── tikv-icon-black.png │ │ │ │ └── tikv-icon-black.svg │ │ │ ├── color │ │ │ │ ├── tikv-icon-color.png │ │ │ │ └── tikv-icon-color.svg │ │ │ └── white │ │ │ │ ├── tikv-icon-white.png │ │ │ │ └── tikv-icon-white.svg │ │ ├── stacked │ │ │ ├── black │ │ │ │ ├── tikv-stacked-black.png │ │ │ │ └── tikv-stacked-black.svg │ │ │ ├── color │ │ │ │ ├── tikv-stacked-color.png │ │ │ │ └── tikv-stacked-color.svg │ │ │ └── white │ │ │ │ ├── tikv-stacked-white.png │ │ │ │ └── tikv-stacked-white.svg │ │ └── horizontal │ │ │ ├── black │ │ │ ├── tikv-horizontal-black.png │ │ │ └── tikv-horizontal-black.svg │ │ │ ├── color │ │ │ ├── tikv-horizontal-color.png │ │ │ ├── tikv-horizontal-color-logo-white-font.png │ │ │ └── tikv-horizontal-color.svg │ │ │ ├── white-deprecated │ │ │ ├── tikv-horizontal-white.png │ │ │ └── tikv-horizontal-white.svg │ │ │ └── white │ │ │ └── tikv-horizontal-white.svg │ ├── docs │ │ ├── tikv-br.png │ │ ├── check-ops.png │ │ ├── rawkv-cdc.png │ │ ├── region-count.png │ │ ├── data-rebalance.png │ │ ├── tikv-storage-1.png │ │ ├── tikv-storage-2.png │ │ ├── tikv-storage-3.png │ │ ├── fault-tolerance-ops.png │ │ ├── monitor-architecture.png │ │ ├── prometheus-in-tikv.png │ │ ├── prometheus-in-tikv2.png │ │ ├── titan-architecture.png │ │ ├── rawkv-cdc-arch-simple.png │ │ ├── fault-tolerance-workload.png │ │ ├── fault-tolerance-leader-recover.png │ │ ├── fault-tolerance-region-count.png │ │ └── region-count-after-load-data.png │ ├── tikv-instance.png │ ├── deep-dive │ │ ├── b-tree.png │ │ ├── monitor.png │ │ ├── select.png │ │ ├── executors.jpg │ │ ├── expression.jpg │ │ ├── lsm-tree.png │ │ ├── multi-raft.png │ │ ├── pd-simulator.png │ │ ├── histogram_init.png │ │ ├── executors-example.jpg │ │ ├── histogram_change.png │ │ ├── mesos-scheduling.png │ │ ├── select-from-tidb.png │ │ ├── coprocessor-select.png │ │ └── mesos-architecture.png │ ├── homepage │ │ ├── hero-bg.png │ │ ├── logo-ctrip.png │ │ ├── logo-meitu.png │ │ ├── logo-pingan.png │ │ ├── logo-tuya.png │ │ ├── logo-JDCloud.png │ │ ├── logo-ZaloPay.png │ │ ├── logo-dailymotion.png │ │ ├── logo-tidbcloud.png │ │ ├── logo-zhuanzhuan.png │ │ ├── develop.svg │ │ ├── get-started.svg │ │ ├── deploy.svg │ │ ├── tikv-logo-white.svg │ │ ├── easy-to-use.svg │ │ └── high-scalability.svg │ ├── tikv-architecture.png │ ├── basic-architecture.png │ └── blog │ │ ├── pprof │ │ ├── flame-graph.gif │ │ ├── graph-of-stack-traces.png │ │ └── find-rust-program-bottlenecks-online-using-go-tool.jpg │ │ ├── RocksDB-in-TiKV │ │ ├── Raft.png │ │ ├── Region.png │ │ ├── others.png │ │ ├── SST-File.png │ │ ├── InsertWithHint.png │ │ ├── Prefix-Iterator.png │ │ ├── table-property1.png │ │ ├── table-property2.png │ │ ├── tikv-architecture.png │ │ └── tikv-architecture2.png │ │ ├── 200-contributors │ │ └── graph.png │ │ ├── monthly-2019 │ │ └── flamegraph.png │ │ ├── pd-transfer │ │ └── pd-transfer.jpg │ │ ├── tikv-read-write │ │ ├── multiraft.png │ │ ├── rawkv-read.jpeg │ │ ├── txnkv-read.jpeg │ │ ├── rawkv-write.jpeg │ │ ├── region-routing.png │ │ ├── txnkv-write.jpeg │ │ └── raft-process-in-tikv.png │ │ ├── graduation │ │ └── TiKV-graduation.jpg │ │ ├── lfx-2020 │ │ ├── TiDB-architecture.png │ │ └── TiDB-TiKV-interaction-model.png │ │ ├── monthly-may-2020 │ │ └── tikv logo.png │ │ ├── follower-read │ │ └── tikv-architecture.png │ │ ├── raft-in-rust │ │ └── the-design-of-raft-rs.png │ │ ├── tikv-on-juicefs │ │ ├── tikv-architecture.png │ │ ├── tikv-on-juicefs-banner.png │ │ └── tikv-mysql-redis-benchmarking.png │ │ ├── community-bridge │ │ ├── github-project-board.png │ │ └── full-chunk-based-computing-roadmap.png │ │ ├── tikv-in-jd-cloud-ai │ │ ├── tikv-architecture.png │ │ ├── data-migration-policy.png │ │ ├── complexity-of-the-metadata-storage-system.png │ │ ├── oss-metadata-storage-system-based-on-tikv.png │ │ ├── redesigning-the-oss-metadata-storage-system.png │ │ └── original-oss-metadata-storage-system-based-on-mysql.png │ │ ├── time-in-distributed-systems │ │ ├── Local_Clock.png │ │ ├── Oder_Of_Events.png │ │ ├── Timestamp_Oracle.png │ │ └── Time_and_Order_in_Distributed_System.png │ │ ├── tune-with-massive-regions │ │ ├── raft-process.png │ │ ├── raft-store-cpu.png │ │ └── propose-wait-duration.png │ │ ├── rust-compilation │ │ ├── rust-compile-time-adventures.png │ │ └── rust-compile-mission-completed.png │ │ ├── building-distributed-storage-systems-on-raft │ │ ├── Raft group.png │ │ ├── Data distribution.png │ │ ├── Hash-based sharding.png │ │ └── Range-based sharding.png │ │ └── tikv-on-shareit │ │ ├── architecture-of-tikv-based-distributed-kv-database.png │ │ └── architecture-of-rocksdb-based-distributed-kv-database.png └── npm │ └── katex-0.10.0-rc.1 │ └── fonts │ ├── KaTeX_Main-Regular.woff2 │ └── KaTeX_Math-Italic.woff2 ├── package.json ├── layouts ├── shortcodes │ ├── danger.html │ ├── info.html │ ├── success.html │ ├── warning.html │ ├── config.html │ ├── features.html │ ├── figure.html │ └── adopters.html ├── _default │ ├── blog │ │ └── navbar-link.html │ ├── single.html │ └── baseof.html ├── blog │ ├── list.html │ └── single.html ├── partials │ ├── blog │ │ ├── post.html │ │ ├── post-list.html │ │ └── hero.html │ ├── docs │ │ ├── version-warning.html │ │ └── hero.html │ ├── meta.html │ ├── admonition.html │ ├── google-analytics.html │ ├── open-graph-tags.html │ ├── javascript.html │ ├── twitter-card.html │ ├── math.html │ └── css.html ├── index.redirects ├── deep-dive │ ├── list.html │ └── single.html └── docs │ ├── list.html │ └── single.html ├── data ├── configs.yaml ├── users.yaml ├── getStarted.yaml └── features.yaml ├── .editorconfig ├── netlify.toml ├── .gitignore ├── .github ├── pull_request_template.md └── ISSUE_TEMPLATE │ ├── question.md │ └── change-request.md ├── yarn.lock ├── Dockerfile ├── Makefile ├── assets └── js │ └── app.js └── README.md /content/blog/_index.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: The TiKV blog 3 | --- 4 | 5 | -------------------------------------------------------------------------------- /static/favicon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/favicon.png -------------------------------------------------------------------------------- /content/blog/zelda.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/content/blog/zelda.png -------------------------------------------------------------------------------- /content/blog/rupees.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/content/blog/rupees.png -------------------------------------------------------------------------------- /static/img/logos/card.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/logos/card.png -------------------------------------------------------------------------------- /static/img/docs/tikv-br.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/docs/tikv-br.png -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "private": true, 3 | "devDependencies": { 4 | "bulma": "^0.7.4" 5 | } 6 | } 7 | -------------------------------------------------------------------------------- /static/img/docs/check-ops.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/docs/check-ops.png -------------------------------------------------------------------------------- /static/img/docs/rawkv-cdc.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/docs/rawkv-cdc.png -------------------------------------------------------------------------------- /static/img/tikv-instance.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/tikv-instance.png -------------------------------------------------------------------------------- /static/img/deep-dive/b-tree.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/deep-dive/b-tree.png -------------------------------------------------------------------------------- /static/img/deep-dive/monitor.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/deep-dive/monitor.png -------------------------------------------------------------------------------- /static/img/deep-dive/select.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/deep-dive/select.png -------------------------------------------------------------------------------- /static/img/docs/region-count.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/docs/region-count.png -------------------------------------------------------------------------------- /static/img/homepage/hero-bg.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/homepage/hero-bg.png -------------------------------------------------------------------------------- /static/img/logos/cncf-color.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/logos/cncf-color.png -------------------------------------------------------------------------------- /static/img/tikv-architecture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/tikv-architecture.png -------------------------------------------------------------------------------- /static/img/basic-architecture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/basic-architecture.png -------------------------------------------------------------------------------- /static/img/deep-dive/executors.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/deep-dive/executors.jpg -------------------------------------------------------------------------------- /static/img/deep-dive/expression.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/deep-dive/expression.jpg -------------------------------------------------------------------------------- /static/img/deep-dive/lsm-tree.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/deep-dive/lsm-tree.png -------------------------------------------------------------------------------- /static/img/deep-dive/multi-raft.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/deep-dive/multi-raft.png -------------------------------------------------------------------------------- /static/img/docs/data-rebalance.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/docs/data-rebalance.png -------------------------------------------------------------------------------- /static/img/docs/tikv-storage-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/docs/tikv-storage-1.png -------------------------------------------------------------------------------- /static/img/docs/tikv-storage-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/docs/tikv-storage-2.png -------------------------------------------------------------------------------- /static/img/docs/tikv-storage-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/docs/tikv-storage-3.png -------------------------------------------------------------------------------- /static/img/homepage/logo-ctrip.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/homepage/logo-ctrip.png -------------------------------------------------------------------------------- /static/img/homepage/logo-meitu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/homepage/logo-meitu.png -------------------------------------------------------------------------------- /static/img/homepage/logo-pingan.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/homepage/logo-pingan.png -------------------------------------------------------------------------------- /static/img/homepage/logo-tuya.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/homepage/logo-tuya.png -------------------------------------------------------------------------------- /content/blog/TiKV-Security-Audit.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/content/blog/TiKV-Security-Audit.pdf -------------------------------------------------------------------------------- /static/img/blog/pprof/flame-graph.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/pprof/flame-graph.gif -------------------------------------------------------------------------------- /static/img/deep-dive/pd-simulator.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/deep-dive/pd-simulator.png -------------------------------------------------------------------------------- /static/img/homepage/logo-JDCloud.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/homepage/logo-JDCloud.png -------------------------------------------------------------------------------- /static/img/homepage/logo-ZaloPay.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/homepage/logo-ZaloPay.png -------------------------------------------------------------------------------- /static/img/blog/RocksDB-in-TiKV/Raft.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/RocksDB-in-TiKV/Raft.png -------------------------------------------------------------------------------- /static/img/deep-dive/histogram_init.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/deep-dive/histogram_init.png -------------------------------------------------------------------------------- /static/img/docs/fault-tolerance-ops.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/docs/fault-tolerance-ops.png -------------------------------------------------------------------------------- /static/img/docs/monitor-architecture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/docs/monitor-architecture.png -------------------------------------------------------------------------------- /static/img/docs/prometheus-in-tikv.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/docs/prometheus-in-tikv.png -------------------------------------------------------------------------------- /static/img/docs/prometheus-in-tikv2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/docs/prometheus-in-tikv2.png -------------------------------------------------------------------------------- /static/img/docs/titan-architecture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/docs/titan-architecture.png -------------------------------------------------------------------------------- /static/img/homepage/logo-dailymotion.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/homepage/logo-dailymotion.png -------------------------------------------------------------------------------- /static/img/homepage/logo-tidbcloud.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/homepage/logo-tidbcloud.png -------------------------------------------------------------------------------- /static/img/homepage/logo-zhuanzhuan.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/homepage/logo-zhuanzhuan.png -------------------------------------------------------------------------------- /static/img/blog/200-contributors/graph.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/200-contributors/graph.png -------------------------------------------------------------------------------- /static/img/blog/RocksDB-in-TiKV/Region.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/RocksDB-in-TiKV/Region.png -------------------------------------------------------------------------------- /static/img/blog/RocksDB-in-TiKV/others.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/RocksDB-in-TiKV/others.png -------------------------------------------------------------------------------- /static/img/deep-dive/executors-example.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/deep-dive/executors-example.jpg -------------------------------------------------------------------------------- /static/img/deep-dive/histogram_change.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/deep-dive/histogram_change.png -------------------------------------------------------------------------------- /static/img/deep-dive/mesos-scheduling.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/deep-dive/mesos-scheduling.png -------------------------------------------------------------------------------- /static/img/deep-dive/select-from-tidb.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/deep-dive/select-from-tidb.png -------------------------------------------------------------------------------- /static/img/docs/rawkv-cdc-arch-simple.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/docs/rawkv-cdc-arch-simple.png -------------------------------------------------------------------------------- /layouts/shortcodes/danger.html: -------------------------------------------------------------------------------- 1 | {{ partial "admonition.html" (dict "type" "danger" "icon" "fa-ban" "text" (.Inner | markdownify)) }} 2 | -------------------------------------------------------------------------------- /static/img/blog/RocksDB-in-TiKV/SST-File.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/RocksDB-in-TiKV/SST-File.png -------------------------------------------------------------------------------- /static/img/blog/monthly-2019/flamegraph.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/monthly-2019/flamegraph.png -------------------------------------------------------------------------------- /static/img/blog/pd-transfer/pd-transfer.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/pd-transfer/pd-transfer.jpg -------------------------------------------------------------------------------- /static/img/blog/tikv-read-write/multiraft.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/tikv-read-write/multiraft.png -------------------------------------------------------------------------------- /static/img/deep-dive/coprocessor-select.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/deep-dive/coprocessor-select.png -------------------------------------------------------------------------------- /static/img/deep-dive/mesos-architecture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/deep-dive/mesos-architecture.png -------------------------------------------------------------------------------- /static/img/docs/fault-tolerance-workload.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/docs/fault-tolerance-workload.png -------------------------------------------------------------------------------- /layouts/shortcodes/info.html: -------------------------------------------------------------------------------- 1 | {{ partial "admonition.html" (dict "type" "info" "icon" "fa-info-circle" "text" (.Inner | markdownify)) }} 2 | -------------------------------------------------------------------------------- /static/img/blog/graduation/TiKV-graduation.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/graduation/TiKV-graduation.jpg -------------------------------------------------------------------------------- /static/img/blog/lfx-2020/TiDB-architecture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/lfx-2020/TiDB-architecture.png -------------------------------------------------------------------------------- /static/img/blog/monthly-may-2020/tikv logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/monthly-may-2020/tikv logo.png -------------------------------------------------------------------------------- /static/img/blog/pprof/graph-of-stack-traces.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/pprof/graph-of-stack-traces.png -------------------------------------------------------------------------------- /static/img/blog/tikv-read-write/rawkv-read.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/tikv-read-write/rawkv-read.jpeg -------------------------------------------------------------------------------- /static/img/blog/tikv-read-write/txnkv-read.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/tikv-read-write/txnkv-read.jpeg -------------------------------------------------------------------------------- /static/img/logos/icon/black/tikv-icon-black.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/logos/icon/black/tikv-icon-black.png -------------------------------------------------------------------------------- /static/img/logos/icon/color/tikv-icon-color.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/logos/icon/color/tikv-icon-color.png -------------------------------------------------------------------------------- /static/img/logos/icon/white/tikv-icon-white.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/logos/icon/white/tikv-icon-white.png -------------------------------------------------------------------------------- /layouts/shortcodes/success.html: -------------------------------------------------------------------------------- 1 | {{ partial "admonition.html" (dict "type" "success" "icon" "fa-check-circle" "text" (.Inner | markdownify)) }} 2 | -------------------------------------------------------------------------------- /layouts/shortcodes/warning.html: -------------------------------------------------------------------------------- 1 | {{ partial "admonition.html" (dict "type" "warning" "icon" "fa-exclamation" "text" (.Inner | markdownify)) }} 2 | -------------------------------------------------------------------------------- /static/img/blog/RocksDB-in-TiKV/InsertWithHint.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/RocksDB-in-TiKV/InsertWithHint.png -------------------------------------------------------------------------------- /static/img/blog/tikv-read-write/rawkv-write.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/tikv-read-write/rawkv-write.jpeg -------------------------------------------------------------------------------- /static/img/blog/tikv-read-write/region-routing.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/tikv-read-write/region-routing.png -------------------------------------------------------------------------------- /static/img/blog/tikv-read-write/txnkv-write.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/tikv-read-write/txnkv-write.jpeg -------------------------------------------------------------------------------- /static/img/docs/fault-tolerance-leader-recover.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/docs/fault-tolerance-leader-recover.png -------------------------------------------------------------------------------- /static/img/docs/fault-tolerance-region-count.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/docs/fault-tolerance-region-count.png -------------------------------------------------------------------------------- /static/img/docs/region-count-after-load-data.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/docs/region-count-after-load-data.png -------------------------------------------------------------------------------- /static/img/blog/RocksDB-in-TiKV/Prefix-Iterator.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/RocksDB-in-TiKV/Prefix-Iterator.png -------------------------------------------------------------------------------- /static/img/blog/RocksDB-in-TiKV/table-property1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/RocksDB-in-TiKV/table-property1.png -------------------------------------------------------------------------------- /static/img/blog/RocksDB-in-TiKV/table-property2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/RocksDB-in-TiKV/table-property2.png -------------------------------------------------------------------------------- /static/img/blog/follower-read/tikv-architecture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/follower-read/tikv-architecture.png -------------------------------------------------------------------------------- /static/img/blog/RocksDB-in-TiKV/tikv-architecture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/RocksDB-in-TiKV/tikv-architecture.png -------------------------------------------------------------------------------- /static/img/blog/RocksDB-in-TiKV/tikv-architecture2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/RocksDB-in-TiKV/tikv-architecture2.png -------------------------------------------------------------------------------- /static/img/blog/raft-in-rust/the-design-of-raft-rs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/raft-in-rust/the-design-of-raft-rs.png -------------------------------------------------------------------------------- /static/img/blog/tikv-on-juicefs/tikv-architecture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/tikv-on-juicefs/tikv-architecture.png -------------------------------------------------------------------------------- /static/img/logos/stacked/black/tikv-stacked-black.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/logos/stacked/black/tikv-stacked-black.png -------------------------------------------------------------------------------- /static/img/logos/stacked/color/tikv-stacked-color.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/logos/stacked/color/tikv-stacked-color.png -------------------------------------------------------------------------------- /static/img/logos/stacked/white/tikv-stacked-white.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/logos/stacked/white/tikv-stacked-white.png -------------------------------------------------------------------------------- /static/img/blog/community-bridge/github-project-board.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/community-bridge/github-project-board.png -------------------------------------------------------------------------------- /static/img/blog/lfx-2020/TiDB-TiKV-interaction-model.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/lfx-2020/TiDB-TiKV-interaction-model.png -------------------------------------------------------------------------------- /static/img/blog/tikv-in-jd-cloud-ai/tikv-architecture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/tikv-in-jd-cloud-ai/tikv-architecture.png -------------------------------------------------------------------------------- /static/img/blog/tikv-read-write/raft-process-in-tikv.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/tikv-read-write/raft-process-in-tikv.png -------------------------------------------------------------------------------- /static/img/blog/tikv-on-juicefs/tikv-on-juicefs-banner.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/tikv-on-juicefs/tikv-on-juicefs-banner.png -------------------------------------------------------------------------------- /static/img/blog/time-in-distributed-systems/Local_Clock.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/time-in-distributed-systems/Local_Clock.png -------------------------------------------------------------------------------- /static/img/blog/tune-with-massive-regions/raft-process.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/tune-with-massive-regions/raft-process.png -------------------------------------------------------------------------------- /static/img/blog/tune-with-massive-regions/raft-store-cpu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/tune-with-massive-regions/raft-store-cpu.png -------------------------------------------------------------------------------- /static/img/logos/horizontal/black/tikv-horizontal-black.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/logos/horizontal/black/tikv-horizontal-black.png -------------------------------------------------------------------------------- /static/img/logos/horizontal/color/tikv-horizontal-color.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/logos/horizontal/color/tikv-horizontal-color.png -------------------------------------------------------------------------------- /static/npm/katex-0.10.0-rc.1/fonts/KaTeX_Main-Regular.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/npm/katex-0.10.0-rc.1/fonts/KaTeX_Main-Regular.woff2 -------------------------------------------------------------------------------- /static/npm/katex-0.10.0-rc.1/fonts/KaTeX_Math-Italic.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/npm/katex-0.10.0-rc.1/fonts/KaTeX_Math-Italic.woff2 -------------------------------------------------------------------------------- /content/docs/3.0/tasks/backup/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Backup 3 | description: Backup TiKV 4 | draft: true 5 | menu: 6 | "3.0": 7 | parent: Tasks 8 | --- -------------------------------------------------------------------------------- /content/docs/4.0/tasks/backup/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Backup 3 | description: Backup TiKV 4 | draft: true 5 | menu: 6 | "4.0": 7 | parent: Tasks 8 | --- -------------------------------------------------------------------------------- /data/configs.yaml: -------------------------------------------------------------------------------- 1 | rocksdb: 2 | - name: max-background-jobs 3 | description: The maximum number of concurrent background jobs (compactions and flushes) 4 | default: 8 5 | -------------------------------------------------------------------------------- /static/img/blog/tikv-in-jd-cloud-ai/data-migration-policy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/tikv-in-jd-cloud-ai/data-migration-policy.png -------------------------------------------------------------------------------- /static/img/blog/time-in-distributed-systems/Oder_Of_Events.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/time-in-distributed-systems/Oder_Of_Events.png -------------------------------------------------------------------------------- /layouts/_default/blog/navbar-link.html: -------------------------------------------------------------------------------- 1 | {{ $date := dateFormat "January 2, 2006" .Date }} 2 | 3 | {{ .Title }} 4 | 5 | -------------------------------------------------------------------------------- /static/img/blog/rust-compilation/rust-compile-time-adventures.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/rust-compilation/rust-compile-time-adventures.png -------------------------------------------------------------------------------- /static/img/blog/tikv-on-juicefs/tikv-mysql-redis-benchmarking.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/tikv-on-juicefs/tikv-mysql-redis-benchmarking.png -------------------------------------------------------------------------------- /static/img/blog/time-in-distributed-systems/Timestamp_Oracle.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/time-in-distributed-systems/Timestamp_Oracle.png -------------------------------------------------------------------------------- /static/img/blog/rust-compilation/rust-compile-mission-completed.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/rust-compilation/rust-compile-mission-completed.png -------------------------------------------------------------------------------- /static/img/blog/tune-with-massive-regions/propose-wait-duration.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/tune-with-massive-regions/propose-wait-duration.png -------------------------------------------------------------------------------- /content/docs/3.0/concepts/features.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Features 3 | description: The features of TiKV 4 | menu: 5 | "3.0": 6 | parent: Concepts 7 | --- 8 | 9 | {{< features >}} -------------------------------------------------------------------------------- /content/docs/4.0/concepts/features.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Features 3 | description: The features of TiKV 4 | menu: 5 | "4.0": 6 | parent: Concepts 7 | --- 8 | 9 | {{< features >}} -------------------------------------------------------------------------------- /static/img/logos/horizontal/white-deprecated/tikv-horizontal-white.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/logos/horizontal/white-deprecated/tikv-horizontal-white.png -------------------------------------------------------------------------------- /static/img/blog/community-bridge/full-chunk-based-computing-roadmap.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/community-bridge/full-chunk-based-computing-roadmap.png -------------------------------------------------------------------------------- /static/img/blog/building-distributed-storage-systems-on-raft/Raft group.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/building-distributed-storage-systems-on-raft/Raft group.png -------------------------------------------------------------------------------- /static/img/logos/horizontal/color/tikv-horizontal-color-logo-white-font.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/logos/horizontal/color/tikv-horizontal-color-logo-white-font.png -------------------------------------------------------------------------------- /layouts/blog/list.html: -------------------------------------------------------------------------------- 1 | {{ define "title" }} 2 | TiKV | Blog 3 | {{ end }} 4 | 5 | {{ define "main" }} 6 | {{ partial "blog/hero.html" . }} 7 | {{ partial "blog/post-list.html" . }} 8 | {{ end }} 9 | -------------------------------------------------------------------------------- /static/img/blog/pprof/find-rust-program-bottlenecks-online-using-go-tool.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/pprof/find-rust-program-bottlenecks-online-using-go-tool.jpg -------------------------------------------------------------------------------- /layouts/blog/single.html: -------------------------------------------------------------------------------- 1 | {{ define "title" }} 2 | The TiKV blog | {{ .Title }} 3 | {{ end }} 4 | 5 | {{ define "main" }} 6 | {{ partial "blog/hero.html" . }} 7 | {{ partial "blog/post.html" . }} 8 | {{ end }} 9 | -------------------------------------------------------------------------------- /static/img/blog/building-distributed-storage-systems-on-raft/Data distribution.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/building-distributed-storage-systems-on-raft/Data distribution.png -------------------------------------------------------------------------------- /static/img/blog/tikv-in-jd-cloud-ai/complexity-of-the-metadata-storage-system.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/tikv-in-jd-cloud-ai/complexity-of-the-metadata-storage-system.png -------------------------------------------------------------------------------- /static/img/blog/tikv-in-jd-cloud-ai/oss-metadata-storage-system-based-on-tikv.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/tikv-in-jd-cloud-ai/oss-metadata-storage-system-based-on-tikv.png -------------------------------------------------------------------------------- /static/img/blog/building-distributed-storage-systems-on-raft/Hash-based sharding.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/building-distributed-storage-systems-on-raft/Hash-based sharding.png -------------------------------------------------------------------------------- /static/img/blog/building-distributed-storage-systems-on-raft/Range-based sharding.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/building-distributed-storage-systems-on-raft/Range-based sharding.png -------------------------------------------------------------------------------- /static/img/blog/tikv-in-jd-cloud-ai/redesigning-the-oss-metadata-storage-system.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/tikv-in-jd-cloud-ai/redesigning-the-oss-metadata-storage-system.png -------------------------------------------------------------------------------- /static/img/blog/time-in-distributed-systems/Time_and_Order_in_Distributed_System.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/time-in-distributed-systems/Time_and_Order_in_Distributed_System.png -------------------------------------------------------------------------------- /static/img/blog/tikv-on-shareit/architecture-of-tikv-based-distributed-kv-database.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/tikv-on-shareit/architecture-of-tikv-based-distributed-kv-database.png -------------------------------------------------------------------------------- /static/img/blog/tikv-on-shareit/architecture-of-rocksdb-based-distributed-kv-database.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/tikv-on-shareit/architecture-of-rocksdb-based-distributed-kv-database.png -------------------------------------------------------------------------------- /static/img/blog/tikv-in-jd-cloud-ai/original-oss-metadata-storage-system-based-on-mysql.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tikv/website/HEAD/static/img/blog/tikv-in-jd-cloud-ai/original-oss-metadata-storage-system-based-on-mysql.png -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | end_of_line = lf 5 | insert_final_newline = true 6 | 7 | [Makefile] 8 | indent_style = tab 9 | 10 | [*.{html,js,json,md,sass,yaml}] 11 | indent_style = space 12 | indent_size = 2 13 | -------------------------------------------------------------------------------- /content/deep-dive/testing/failure_injection.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Failure Injection 3 | aliases: ['/docs/deep-dive/testing/failure_injection'] 4 | menu: 5 | nav: 6 | parent: Testing 7 | weight: 1 8 | --- 9 | 10 | -------------------------------------------------------------------------------- /content/docs/3.0/releases/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Releases 3 | description: TiKV Release Notes 4 | menu: 5 | "3.0": 6 | name: Releases 7 | weight: 4 8 | --- 9 | 10 | This section contains release notes for TiKV and PD. -------------------------------------------------------------------------------- /content/docs/4.0/releases/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Releases 3 | description: TiKV Release Notes 4 | menu: 5 | "4.0": 6 | name: Releases 7 | weight: 4 8 | --- 9 | 10 | This section contains release notes for TiKV and PD. -------------------------------------------------------------------------------- /content/docs/3.0/reference/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Reference 3 | description: Details about TiKV 4 | menu: 5 | "3.0": 6 | name: Reference 7 | weight: 3 8 | --- 9 | 10 | This section includes instructions on using TiKV clients and tools. -------------------------------------------------------------------------------- /content/docs/4.0/reference/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Reference 3 | description: Details about TiKV 4 | menu: 5 | "4.0": 6 | name: Reference 7 | weight: 3 8 | --- 9 | 10 | This section includes instructions on using TiKV clients and tools. -------------------------------------------------------------------------------- /layouts/partials/blog/post.html: -------------------------------------------------------------------------------- 1 |
2 |
3 |
4 | {{ partial "math.html" . }} 5 | {{ .Content }} 6 |
7 |
8 |
9 | -------------------------------------------------------------------------------- /netlify.toml: -------------------------------------------------------------------------------- 1 | [build] 2 | publish = "public" 3 | command = "make production-build" 4 | 5 | [build.environment] 6 | HUGO_VERSION = "0.66.0" 7 | 8 | [context.deploy-preview] 9 | command = "make preview-build" 10 | 11 | [context.branch-deploy] 12 | command = "make preview-build" 13 | -------------------------------------------------------------------------------- /layouts/partials/docs/version-warning.html: -------------------------------------------------------------------------------- 1 | {{ if false }} 2 |
3 | This document is for version TODO, which is no longer the latest version. Click here to see the latest version (which is TODO). 4 |
5 | {{ end }} 6 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # macOS-specific assets 2 | .DS_Store 3 | 4 | # Yarn-generated assets 5 | node_modules/ 6 | 7 | # Hugo-generated assets 8 | public/ 9 | resources/ 10 | .hugo_build.lock 11 | 12 | # Ruby assets 13 | .bundle/ 14 | vendor/bundle/ 15 | 16 | # Temporary files generated during preview 17 | *.md-e 18 | -------------------------------------------------------------------------------- /content/docs/3.0/reference/tools/pd-server.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: pd-server 3 | description: Learn about interacting with pd-server 4 | menu: 5 | "3.0": 6 | parent: Tools 7 | weight: 3 8 | --- 9 | 10 | You can explore `pd-server --help` and try `pd-server your sub command --help` to dig into functionality. -------------------------------------------------------------------------------- /content/docs/4.0/reference/tools/pd-server.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: pd-server 3 | description: Learn about interacting with pd-server 4 | menu: 5 | "4.0": 6 | parent: Tools 7 | weight: 3 8 | --- 9 | 10 | You can explore `pd-server --help` and try `pd-server your sub command --help` to dig into functionality. -------------------------------------------------------------------------------- /content/docs/dev/new-features/overview.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: What's New 3 | description: New features and improvements about TiKV since 6.6 4 | menu: 5 | "dev": 6 | weight: 1 7 | identifier: What's New-dev 8 | --- 9 | 10 | This document lists some significant features and improvements after **TiKV 7.1**. 11 | -------------------------------------------------------------------------------- /content/docs/3.0/tasks/try/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Try 3 | description: Try TiKV 4 | menu: 5 | "3.0": 6 | parent: Tasks 7 | weight: 1 8 | --- 9 | 10 | There are two ways to start a TiKV cluster: 11 | 12 | * [Getting Started with TiKV Operator](../tikv-operator) 13 | * [Using Docker Stack](../docker-stack) -------------------------------------------------------------------------------- /content/docs/3.0/reference/tools/tikv-server.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: tikv-server 3 | description: Learn about interacting with tikv-server 4 | menu: 5 | "3.0": 6 | parent: Tools 7 | weight: 1 8 | --- 9 | 10 | You can explore `tikv-server --help` and try `tikv-server your sub command --help` to dig into this functionality. -------------------------------------------------------------------------------- /content/docs/4.0/reference/tools/tikv-server.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: tikv-server 3 | description: Learn about interacting with tikv-server 4 | menu: 5 | "4.0": 6 | parent: Tools 7 | weight: 1 8 | --- 9 | 10 | You can explore `tikv-server --help` and try `tikv-server your sub command --help` to dig into this functionality. -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | ### What is changed? 4 | 5 | 6 | 7 | ### Any related PRs or issues? 8 | 9 | 10 | 11 | ### Which version does your change affect? 12 | -------------------------------------------------------------------------------- /content/docs/5.1/deploy/configure/storage.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Storage Config 3 | description: Learn how to configure storage in TiKV. 4 | menu: 5 | "5.1": 6 | parent: Configure TiKV 7 | weight: 12 8 | --- 9 | 10 | 11 | You can find all the configuration parameters related to Storage [here](../tikv-configuration-file/#storage). -------------------------------------------------------------------------------- /content/docs/5.1/deploy/configure/grpc.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: gRPC Config 3 | description: Learn how to configure gRPC in TiKV. 4 | menu: 5 | "5.1": 6 | parent: Configure TiKV 7 | weight: 13 8 | --- 9 | 10 | You can find all the configuration parameters related to gRPC [here](../tikv-configuration-file/#server) (started with `grpc-`). -------------------------------------------------------------------------------- /content/docs/5.1/deploy/configure/raftstore.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Raftstore Config 3 | description: Learn how to configure Raftstore in TiKV. 4 | menu: 5 | "5.1": 6 | parent: Configure TiKV 7 | weight: 10 8 | --- 9 | 10 | You can find all the configuration parameters related to Raftstore [here](../tikv-configuration-file/#raftstore). -------------------------------------------------------------------------------- /content/docs/5.1/deploy/configure/coprocessor.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Coprocessor Config 3 | description: Learn how to configure Coprocessor in TiKV. 4 | menu: 5 | "5.1": 6 | parent: Configure TiKV 7 | weight: 14 8 | --- 9 | 10 | You can find all the configuration parameters related to Coprocessor [here](../tikv-configuration-file/#coprocessor). -------------------------------------------------------------------------------- /content/docs/4.0/tasks/try/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Try 3 | description: Try TiKV 4 | menu: 5 | "4.0": 6 | parent: Tasks 7 | weight: 1 8 | --- 9 | 10 | There are two ways to quickly spin up a TiKV cluster for testing purposes: 11 | 12 | * [Getting Started with TiKV Operator](../tikv-operator) 13 | * [Using Docker Stack](../docker-stack) -------------------------------------------------------------------------------- /yarn.lock: -------------------------------------------------------------------------------- 1 | # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. 2 | # yarn lockfile v1 3 | 4 | 5 | bulma@^0.7.4: 6 | version "0.7.5" 7 | resolved "https://registry.yarnpkg.com/bulma/-/bulma-0.7.5.tgz#35066c37f82c088b68f94450be758fc00a967208" 8 | integrity sha512-cX98TIn0I6sKba/DhW0FBjtaDpxTelU166pf7ICXpCCuplHWyu6C9LYZmL5PEsnePIeJaiorsTEzzNk3Tsm1hw== 9 | -------------------------------------------------------------------------------- /layouts/partials/meta.html: -------------------------------------------------------------------------------- 1 | {{ $favicon := site.Params.favicon | relURL }} 2 | {{ $rssFeed := "blog/index.xml" | absURL }} 3 | 4 | 5 | {{ hugo.Generator }} 6 | 7 | 8 | 9 | -------------------------------------------------------------------------------- /content/docs/6.1/deploy/configure/grpc.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: gRPC Config 3 | description: Learn how to configure gRPC in TiKV. 4 | menu: 5 | "6.1": 6 | parent: Configure TiKV-v6.1 7 | weight: 13 8 | identifier: gRPC Config-v6.1 9 | --- 10 | 11 | You can find all the configuration parameters related to gRPC [here](../tikv-configuration-file/#server) (started with `grpc-`). 12 | -------------------------------------------------------------------------------- /content/docs/6.1/deploy/configure/storage.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Storage Config 3 | description: Learn how to configure storage in TiKV. 4 | menu: 5 | "6.1": 6 | parent: Configure TiKV-v6.1 7 | weight: 12 8 | identifier: Storage Config-v6.1 9 | --- 10 | 11 | 12 | You can find all the configuration parameters related to Storage [here](../tikv-configuration-file/#storage). 13 | -------------------------------------------------------------------------------- /content/docs/6.5/deploy/configure/grpc.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: gRPC Config 3 | description: Learn how to configure gRPC in TiKV. 4 | menu: 5 | "6.5": 6 | parent: Configure TiKV-6.5 7 | weight: 13 8 | identifier: gRPC Config-6.5 9 | --- 10 | 11 | You can find all the configuration parameters related to gRPC [here](../tikv-configuration-file/#server) (started with `grpc-`). 12 | -------------------------------------------------------------------------------- /content/docs/6.5/deploy/configure/storage.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Storage Config 3 | description: Learn how to configure storage in TiKV. 4 | menu: 5 | "6.5": 6 | parent: Configure TiKV-6.5 7 | weight: 12 8 | identifier: Storage Config-6.5 9 | --- 10 | 11 | 12 | You can find all the configuration parameters related to Storage [here](../tikv-configuration-file/#storage). 13 | -------------------------------------------------------------------------------- /content/docs/7.1/deploy/configure/grpc.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: gRPC Config 3 | description: Learn how to configure gRPC in TiKV. 4 | menu: 5 | "7.1": 6 | parent: Configure TiKV-7.1 7 | weight: 13 8 | identifier: gRPC Config-7.1 9 | --- 10 | 11 | You can find all the configuration parameters related to gRPC [here](../tikv-configuration-file/#server) (started with `grpc-`). 12 | -------------------------------------------------------------------------------- /content/docs/7.1/deploy/configure/storage.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Storage Config 3 | description: Learn how to configure storage in TiKV. 4 | menu: 5 | "7.1": 6 | parent: Configure TiKV-7.1 7 | weight: 12 8 | identifier: Storage Config-7.1 9 | --- 10 | 11 | 12 | You can find all the configuration parameters related to Storage [here](../tikv-configuration-file/#storage). 13 | -------------------------------------------------------------------------------- /content/docs/dev/deploy/configure/grpc.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: gRPC Config 3 | description: Learn how to configure gRPC in TiKV. 4 | menu: 5 | "dev": 6 | parent: Configure TiKV-dev 7 | weight: 13 8 | identifier: gRPC Config-dev 9 | --- 10 | 11 | You can find all the configuration parameters related to gRPC [here](../tikv-configuration-file/#server) (started with `grpc-`). 12 | -------------------------------------------------------------------------------- /content/docs/dev/deploy/configure/storage.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Storage Config 3 | description: Learn how to configure storage in TiKV. 4 | menu: 5 | "dev": 6 | parent: Configure TiKV-dev 7 | weight: 12 8 | identifier: Storage Config-dev 9 | --- 10 | 11 | 12 | You can find all the configuration parameters related to Storage [here](../tikv-configuration-file/#storage). 13 | -------------------------------------------------------------------------------- /content/docs/6.1/deploy/configure/raftstore.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Raftstore Config 3 | description: Learn how to configure Raftstore in TiKV. 4 | menu: 5 | "6.1": 6 | parent: Configure TiKV-v6.1 7 | weight: 10 8 | identifier: Raftstore Config-v6.1 9 | --- 10 | 11 | You can find all the configuration parameters related to Raftstore [here](../tikv-configuration-file/#raftstore). 12 | -------------------------------------------------------------------------------- /content/docs/6.5/deploy/configure/raftstore.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Raftstore Config 3 | description: Learn how to configure Raftstore in TiKV. 4 | menu: 5 | "6.5": 6 | parent: Configure TiKV-6.5 7 | weight: 10 8 | identifier: Raftstore Config-6.5 9 | --- 10 | 11 | You can find all the configuration parameters related to Raftstore [here](../tikv-configuration-file/#raftstore). 12 | -------------------------------------------------------------------------------- /content/docs/7.1/deploy/configure/raftstore.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Raftstore Config 3 | description: Learn how to configure Raftstore in TiKV. 4 | menu: 5 | "7.1": 6 | parent: Configure TiKV-7.1 7 | weight: 10 8 | identifier: Raftstore Config-7.1 9 | --- 10 | 11 | You can find all the configuration parameters related to Raftstore [here](../tikv-configuration-file/#raftstore). 12 | -------------------------------------------------------------------------------- /content/docs/dev/deploy/configure/raftstore.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Raftstore Config 3 | description: Learn how to configure Raftstore in TiKV. 4 | menu: 5 | "dev": 6 | parent: Configure TiKV-dev 7 | weight: 10 8 | identifier: Raftstore Config-dev 9 | --- 10 | 11 | You can find all the configuration parameters related to Raftstore [here](../tikv-configuration-file/#raftstore). 12 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM alpine:latest 2 | RUN apk update 3 | RUN apk add hugo yarn make git 4 | 5 | RUN adduser builder -D 6 | USER builder 7 | 8 | RUN mkdir -p /home/builder/build 9 | WORKDIR /home/builder/build 10 | COPY package.json /home/builder/build 11 | COPY yarn.lock /home/builder/build 12 | RUN yarn 13 | 14 | COPY . /home/builder/build 15 | CMD /bin/sh -c "yarn && make serve-production" 16 | EXPOSE 1313 17 | -------------------------------------------------------------------------------- /content/docs/6.5/deploy/configure/coprocessor.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Coprocessor Config 3 | description: Learn how to configure Coprocessor in TiKV. 4 | menu: 5 | "6.5": 6 | parent: Configure TiKV-6.5 7 | weight: 14 8 | identifier: Coprocessor Config-6.5 9 | --- 10 | 11 | You can find all the configuration parameters related to Coprocessor [here](../tikv-configuration-file/#coprocessor). 12 | -------------------------------------------------------------------------------- /content/docs/7.1/deploy/configure/coprocessor.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Coprocessor Config 3 | description: Learn how to configure Coprocessor in TiKV. 4 | menu: 5 | "7.1": 6 | parent: Configure TiKV-7.1 7 | weight: 14 8 | identifier: Coprocessor Config-7.1 9 | --- 10 | 11 | You can find all the configuration parameters related to Coprocessor [here](../tikv-configuration-file/#coprocessor). 12 | -------------------------------------------------------------------------------- /content/docs/dev/deploy/configure/coprocessor.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Coprocessor Config 3 | description: Learn how to configure Coprocessor in TiKV. 4 | menu: 5 | "dev": 6 | parent: Configure TiKV-dev 7 | weight: 14 8 | identifier: Coprocessor Config-dev 9 | --- 10 | 11 | You can find all the configuration parameters related to Coprocessor [here](../tikv-configuration-file/#coprocessor). 12 | -------------------------------------------------------------------------------- /content/docs/6.1/deploy/configure/coprocessor.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Coprocessor Config 3 | description: Learn how to configure Coprocessor in TiKV. 4 | menu: 5 | "6.1": 6 | parent: Configure TiKV-v6.1 7 | weight: 14 8 | identifier: Coprocessor Config-v6.1 9 | --- 10 | 11 | You can find all the configuration parameters related to Coprocessor [here](../tikv-configuration-file/#coprocessor). 12 | -------------------------------------------------------------------------------- /static/img/homepage/develop.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | </> 4 | 5 | 6 | -------------------------------------------------------------------------------- /layouts/partials/admonition.html: -------------------------------------------------------------------------------- 1 | {{ $type := .type }} 2 | {{ $icon := .icon }} 3 | {{ $text := .text }} 4 |
5 |
6 |
7 | 8 | 9 | 10 |
11 |
12 | {{ $text }} 13 |
14 |
15 |
16 | -------------------------------------------------------------------------------- /content/docs/5.1/deploy/performance/performance.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Benchmark and Performance 3 | description: Learn about the performance of TiKV. 4 | menu: 5 | "5.1": 6 | parent: Deploy 7 | weight: 4 8 | --- 9 | 10 | This section introduces an overview of TiKV performance and the instructions to do a benchmark. 11 | 12 | - [Performance Overview](../overview) 13 | - [Benchmark Instructions](../instructions) 14 | -------------------------------------------------------------------------------- /layouts/partials/blog/post-list.html: -------------------------------------------------------------------------------- 1 | {{ $posts := where site.RegularPages "Section" "blog" }} 2 |
3 |
4 |
5 | {{ range $posts }} 6 |
7 | {{ .Render "blog/card" }} 8 |
9 | {{ end }} 10 |
11 |
12 |
13 | -------------------------------------------------------------------------------- /content/docs/3.0/reference/clients/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Clients 3 | description: Interact with TiKV using the raw key-value API or the transactional key-value API 4 | menu: 5 | "3.0": 6 | parent: Reference 7 | weight: 2 8 | --- 9 | 10 | TiKV has clients for a number of languages: 11 | 12 | * [Go](../go) (Stable) 13 | * [Java](../java) (Unstable) 14 | * [Rust](../rust) (Unstable) 15 | * [C](../c) (early development) -------------------------------------------------------------------------------- /content/docs/4.0/reference/clients/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Clients 3 | description: Interact with TiKV using the raw key-value API or the transactional key-value API 4 | menu: 5 | "4.0": 6 | parent: Reference 7 | weight: 2 8 | --- 9 | 10 | TiKV has clients for a number of languages: 11 | 12 | * [Go](../go) (Stable) 13 | * [Java](../java) (Unstable) 14 | * [Rust](../rust) (Unstable) 15 | * [C](../c) (early development) -------------------------------------------------------------------------------- /content/docs/5.1/reference/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Reference 3 | description: Learn about technical details of TiKV 4 | menu: 5 | "5.1": 6 | weight: 3 7 | --- 8 | 9 | This chapter describes some technical details of TiKV: 10 | 11 | - [TiKV Architecture](../architecture/introduction/) 12 | - [Query Layers](../query-layers/) 13 | - [TiUP](../tiup/) 14 | - [Command-Line Interface](../cli/introduction/) 15 | - [FAQs](../faq/) 16 | -------------------------------------------------------------------------------- /layouts/index.redirects: -------------------------------------------------------------------------------- 1 | # {{- $latest := site.Params.versions.latest }} 2 | /docs /docs/{{ $latest }}/concepts/overview/ 301! 3 | /docs/latest /docs/{{ $latest }}/concepts/ 301 4 | /docs/latest/* /docs/{{ $latest }}/:splat 301 5 | /security /docs/{{ $latest }}/tasks/configure/security/ 301 6 | /chat https://join.slack.com/t/tikv-wg/shared_invite/enQtNTUyODE4ODU2MzI0LWVlMWMzMDkyNWE5ZjY1ODAzMWUwZGVhNGNhYTc3MzJhYWE0Y2FjYjliYzY1OWJlYTc4OWVjZWM1NDkwN2QxNDE 7 | -------------------------------------------------------------------------------- /content/docs/5.1/reference/TiUP.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: TiUP 3 | description: TiUP documentation 4 | menu: 5 | "5.1": 6 | parent: Reference 7 | weight: 3 8 | --- 9 | 10 | Starting with TiKV 4.0, TiUP, as the package manager, makes it easier to manage different cluster components in the TiKV ecosystem. 11 | 12 | For more TiUP commands and usages, refer to the [TiUP documentation guide](https://docs.pingcap.com/tidb/stable/tiup-documentation-guide). 13 | -------------------------------------------------------------------------------- /layouts/partials/google-analytics.html: -------------------------------------------------------------------------------- 1 | {{ $googleAnalyticsId := site.Params.googleAnalyticsId }} 2 | 3 | 4 | 11 | -------------------------------------------------------------------------------- /content/docs/5.1/deploy/install/install.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Install TiKV 3 | description: TiKV deployment prerequisites and methods 4 | menu: 5 | "5.1": 6 | parent: Deploy 7 | weight: 1 8 | --- 9 | 10 | This section introduces how to deploy and verify a TiKV cluster in the production environment. 11 | 12 | - [Prerequisites](../prerequisites) 13 | - [Production Deployment](../production) 14 | - [Verify Cluster Status](../verify) 15 | - [Test Deployment](../test) -------------------------------------------------------------------------------- /content/docs/6.1/reference/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Reference 3 | description: Learn about technical details of TiKV 4 | menu: 5 | "6.1": 6 | weight: 3 7 | identifier: Reference-v6.1 8 | --- 9 | 10 | This chapter describes some technical details of TiKV: 11 | 12 | - [TiKV Architecture](../architecture/introduction/) 13 | - [Query Layers](../query-layers/) 14 | - [TiUP](../tiup/) 15 | - [Command-Line Interface](../cli/introduction/) 16 | - [FAQs](../faq/) 17 | -------------------------------------------------------------------------------- /content/docs/6.5/reference/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Reference 3 | description: Learn about technical details of TiKV 4 | menu: 5 | "6.5": 6 | weight: 3 7 | identifier: Reference-6.5 8 | --- 9 | 10 | This chapter describes some technical details of TiKV: 11 | 12 | - [TiKV Architecture](../architecture/introduction/) 13 | - [Query Layers](../query-layers/) 14 | - [TiUP](../tiup/) 15 | - [Command-Line Interface](../cli/introduction/) 16 | - [FAQs](../faq/) 17 | -------------------------------------------------------------------------------- /content/docs/7.1/reference/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Reference 3 | description: Learn about technical details of TiKV 4 | menu: 5 | "7.1": 6 | weight: 3 7 | identifier: Reference-7.1 8 | --- 9 | 10 | This chapter describes some technical details of TiKV: 11 | 12 | - [TiKV Architecture](../architecture/introduction/) 13 | - [Query Layers](../query-layers/) 14 | - [TiUP](../tiup/) 15 | - [Command-Line Interface](../cli/introduction/) 16 | - [FAQs](../faq/) 17 | -------------------------------------------------------------------------------- /content/docs/dev/reference/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Reference 3 | description: Learn about technical details of TiKV 4 | menu: 5 | "dev": 6 | weight: 3 7 | identifier: Reference-dev 8 | --- 9 | 10 | This chapter describes some technical details of TiKV: 11 | 12 | - [TiKV Architecture](../architecture/introduction/) 13 | - [Query Layers](../query-layers/) 14 | - [TiUP](../tiup/) 15 | - [Command-Line Interface](../cli/introduction/) 16 | - [FAQs](../faq/) 17 | -------------------------------------------------------------------------------- /content/docs/6.1/deploy/performance/performance.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Benchmark and Performance 3 | description: Learn about the performance of TiKV. 4 | menu: 5 | "6.1": 6 | parent: Deploy-v6.1 7 | weight: 4 8 | identifier: Benchmark and Performance-v6.1 9 | --- 10 | 11 | This section introduces an overview of TiKV performance and the instructions to do a benchmark. 12 | 13 | - [Performance Overview](../overview) 14 | - [Benchmark Instructions](../instructions) 15 | -------------------------------------------------------------------------------- /content/docs/6.5/deploy/performance/performance.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Benchmark and Performance 3 | description: Learn about the performance of TiKV. 4 | menu: 5 | "6.5": 6 | parent: Deploy-6.5 7 | weight: 4 8 | identifier: Benchmark and Performance-6.5 9 | --- 10 | 11 | This section introduces an overview of TiKV performance and the instructions to do a benchmark. 12 | 13 | - [Performance Overview](../overview) 14 | - [Benchmark Instructions](../instructions) 15 | -------------------------------------------------------------------------------- /content/docs/7.1/deploy/performance/performance.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Benchmark and Performance 3 | description: Learn about the performance of TiKV. 4 | menu: 5 | "7.1": 6 | parent: Deploy-7.1 7 | weight: 4 8 | identifier: Benchmark and Performance-7.1 9 | --- 10 | 11 | This section introduces an overview of TiKV performance and the instructions to do a benchmark. 12 | 13 | - [Performance Overview](../overview) 14 | - [Benchmark Instructions](../instructions) 15 | -------------------------------------------------------------------------------- /content/docs/dev/deploy/performance/performance.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Benchmark and Performance 3 | description: Learn about the performance of TiKV. 4 | menu: 5 | "dev": 6 | parent: Deploy-dev 7 | weight: 4 8 | identifier: Benchmark and Performance-dev 9 | --- 10 | 11 | This section introduces an overview of TiKV performance and the instructions to do a benchmark. 12 | 13 | - [Performance Overview](../overview) 14 | - [Benchmark Instructions](../instructions) 15 | -------------------------------------------------------------------------------- /content/docs/5.1/deploy/operate/operate.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Operate TiKV 3 | description: Learn how to maintain and operate a TiKV cluster. 4 | menu: 5 | "5.1": 6 | parent: Deploy 7 | weight: 5 8 | --- 9 | 10 | This section introduces how to maintain and operate a TiKV cluster, including the following operations: 11 | 12 | - [Upgrade a TiKV cluster using TiUP](../upgrade) 13 | - [Scale out/in a TiKV cluster using TiUP](../scale) 14 | - [Maintain a TiKV cluster using TiUP](../maintain) 15 | -------------------------------------------------------------------------------- /content/docs/6.1/reference/TiUP.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: TiUP 3 | description: TiUP documentation 4 | menu: 5 | "6.1": 6 | parent: Reference-v6.1 7 | weight: 3 8 | identifier: TiUP-v6.1 9 | --- 10 | 11 | Starting with TiKV 4.0, TiUP, as the package manager, makes it easier to manage different cluster components in the TiKV ecosystem. 12 | 13 | For more TiUP commands and usages, refer to the [TiUP documentation guide](https://docs.pingcap.com/tidb/stable/tiup-documentation-guide). 14 | -------------------------------------------------------------------------------- /content/docs/6.5/reference/TiUP.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: TiUP 3 | description: TiUP documentation 4 | menu: 5 | "6.5": 6 | parent: Reference-6.5 7 | weight: 3 8 | identifier: TiUP-6.5 9 | --- 10 | 11 | Starting with TiKV 4.0, TiUP, as the package manager, makes it easier to manage different cluster components in the TiKV ecosystem. 12 | 13 | For more TiUP commands and usages, refer to the [TiUP documentation guide](https://docs.pingcap.com/tidb/stable/tiup-documentation-guide). 14 | -------------------------------------------------------------------------------- /content/docs/7.1/reference/TiUP.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: TiUP 3 | description: TiUP documentation 4 | menu: 5 | "7.1": 6 | parent: Reference-7.1 7 | weight: 3 8 | identifier: TiUP-7.1 9 | --- 10 | 11 | Starting with TiKV 4.0, TiUP, as the package manager, makes it easier to manage different cluster components in the TiKV ecosystem. 12 | 13 | For more TiUP commands and usages, refer to the [TiUP documentation guide](https://docs.pingcap.com/tidb/stable/tiup-documentation-guide). 14 | -------------------------------------------------------------------------------- /content/docs/dev/reference/TiUP.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: TiUP 3 | description: TiUP documentation 4 | menu: 5 | "dev": 6 | parent: Reference-dev 7 | weight: 3 8 | identifier: TiUP-dev 9 | --- 10 | 11 | Starting with TiKV 4.0, TiUP, as the package manager, makes it easier to manage different cluster components in the TiKV ecosystem. 12 | 13 | For more TiUP commands and usages, refer to the [TiUP documentation guide](https://docs.pingcap.com/tidb/stable/tiup-documentation-guide). 14 | -------------------------------------------------------------------------------- /content/docs/3.0/reference/clients/java.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Java Client 3 | description: Interact with TiKV using Java. 4 | menu: 5 | "3.0": 6 | parent: Clients 7 | weight: 3 8 | --- 9 | 10 | This document, like our Java API, is still a work in progress. In the meantime, you can track development at [tikv/client-java](https://github.com/tikv/client-java/) repository. 11 | 12 | {{< warning >}} 13 | You should not use the Java client for production use until it is released. 14 | {{< /warning >}} -------------------------------------------------------------------------------- /content/docs/4.0/reference/clients/java.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Java Client 3 | description: Interact with TiKV using Java. 4 | menu: 5 | "4.0": 6 | parent: Clients 7 | weight: 3 8 | --- 9 | 10 | This document, like our Java API, is still a work in progress. In the meantime, you can track development at [tikv/client-java](https://github.com/tikv/client-java/) repository. 11 | 12 | {{< warning >}} 13 | You should not use the Java client for production use until it is released. 14 | {{< /warning >}} -------------------------------------------------------------------------------- /content/community/sig-engine.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Engine SIG 3 | description: Information about the engine special interest group 4 | --- 5 | 6 | Covers engine related work in TiKV, including supporting various engines in TiKV and engine improvements. 7 | 8 | For more information, see [our page](https://github.com/tikv/community/tree/master/sig/engine) in the TiKV community repo. 9 | 10 | You can contact the coprocessor SIG via [Slack](https://slack.tidb.io/invite?team=tikv-wg&channel=sig-engine&ref=github-sig). 11 | -------------------------------------------------------------------------------- /content/docs/5.1/deploy/monitor/monitor.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Monitor and Alert 3 | description: Learn how to monitor a TiKV cluster. 4 | menu: 5 | "5.1": 6 | parent: Deploy 7 | weight: 4 8 | --- 9 | 10 | This section introduces how to monitor a TiKV cluster. 11 | 12 | - [Monitor Framework](../framework) 13 | - [Monitor API](../api) 14 | - [Deploy Monitoring Services](../deploy) 15 | - [Export Grafana Shapshots](../grafana) 16 | - [Key Metrics](../key-metrics) 17 | - [TiKV Cluster Alert Rules](../alert) 18 | -------------------------------------------------------------------------------- /content/docs/6.1/deploy/install/install.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Install TiKV 3 | description: TiKV deployment prerequisites and methods 4 | menu: 5 | "6.1": 6 | parent: Deploy-v6.1 7 | weight: 1 8 | identifier: Install TiKV-v6.1 9 | --- 10 | 11 | This section introduces how to deploy and verify a TiKV cluster in the production environment. 12 | 13 | - [Prerequisites](../prerequisites) 14 | - [Production Deployment](../production) 15 | - [Verify Cluster Status](../verify) 16 | - [Test Deployment](../test) 17 | -------------------------------------------------------------------------------- /content/docs/6.5/deploy/install/install.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Install TiKV 3 | description: TiKV deployment prerequisites and methods 4 | menu: 5 | "6.5": 6 | parent: Deploy-6.5 7 | weight: 1 8 | identifier: Install TiKV-6.5 9 | --- 10 | 11 | This section introduces how to deploy and verify a TiKV cluster in the production environment. 12 | 13 | - [Prerequisites](../prerequisites) 14 | - [Production Deployment](../production) 15 | - [Verify Cluster Status](../verify) 16 | - [Test Deployment](../test) 17 | -------------------------------------------------------------------------------- /content/docs/7.1/deploy/install/install.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Install TiKV 3 | description: TiKV deployment prerequisites and methods 4 | menu: 5 | "7.1": 6 | parent: Deploy-7.1 7 | weight: 1 8 | identifier: Install TiKV-7.1 9 | --- 10 | 11 | This section introduces how to deploy and verify a TiKV cluster in the production environment. 12 | 13 | - [Prerequisites](../prerequisites) 14 | - [Production Deployment](../production) 15 | - [Verify Cluster Status](../verify) 16 | - [Test Deployment](../test) 17 | -------------------------------------------------------------------------------- /content/docs/dev/deploy/install/install.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Install TiKV 3 | description: TiKV deployment prerequisites and methods 4 | menu: 5 | "dev": 6 | parent: Deploy-dev 7 | weight: 1 8 | identifier: Install TiKV-dev 9 | --- 10 | 11 | This section introduces how to deploy and verify a TiKV cluster in the production environment. 12 | 13 | - [Prerequisites](../prerequisites) 14 | - [Production Deployment](../production) 15 | - [Verify Cluster Status](../verify) 16 | - [Test Deployment](../test) 17 | -------------------------------------------------------------------------------- /content/docs/3.0/reference/clients/c.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: C Client 3 | description: Interact with TiKV using C. 4 | menu: 5 | "3.0": 6 | parent: Clients 7 | weight: 4 8 | --- 9 | 10 | This document, like our C API, is still a work in progress. In the meantime, you can track development at [tikv/client-c](https://github.com/tikv/client-c/) repository. Most development happens on the `dev` branch. 11 | 12 | {{< warning >}} 13 | You should not use the C client for production use until it is released. 14 | {{< /warning >}} -------------------------------------------------------------------------------- /content/docs/4.0/reference/clients/c.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: C Client 3 | description: Interact with TiKV using C. 4 | menu: 5 | "4.0": 6 | parent: Clients 7 | weight: 4 8 | --- 9 | 10 | This document, like our C API, is still a work in progress. In the meantime, you can track development at [tikv/client-c](https://github.com/tikv/client-c/) repository. Most development happens on the `dev` branch. 11 | 12 | {{< warning >}} 13 | You should not use the C client for production use until it is released. 14 | {{< /warning >}} -------------------------------------------------------------------------------- /content/community/sig-raft.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Raft SIG 3 | description: Information about the Raft special interest group 4 | --- 5 | 6 | Covers [Raf related work in TiKV, including optimize [raft-rs](https://github.com/tikv/raft-rs) and the Multi-Raft implementation in TiKV. 7 | 8 | For more information, see [our page](https://github.com/tikv/community/tree/master/sig/raft) in the TiKV community repo. 9 | 10 | You can contact the coprocessor SIG via [Slack](https://slack.tidb.io/invite?team=tikv-wg&channel=sig-raft&ref=github-sig). 11 | -------------------------------------------------------------------------------- /content/docs/5.1/develop/clients/go.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Go Client 3 | description: Interact with TiKV using Go. 4 | menu: 5 | "5.1": 6 | parent: TiKV Clients 7 | weight: 2 8 | --- 9 | 10 | TiKV Go Client is still in the proof-of-concept stage and under development. You can track the development at [tikv/client-go](https://github.com/tikv/client-go/) repository. 11 | 12 | {{< warning >}} 13 | Before TiKV Go Client is officially released, it is not recommended to be used in a production environment. 14 | {{< /warning >}} 15 | -------------------------------------------------------------------------------- /content/docs/6.1/deploy/operate/operate.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Operate TiKV 3 | description: Learn how to maintain and operate a TiKV cluster. 4 | menu: 5 | "6.1": 6 | parent: Deploy-v6.1 7 | weight: 5 8 | identifier: Operate TiKV-v6.1 9 | --- 10 | 11 | This section introduces how to maintain and operate a TiKV cluster, including the following operations: 12 | 13 | - [Upgrade a TiKV cluster using TiUP](../upgrade) 14 | - [Scale out/in a TiKV cluster using TiUP](../scale) 15 | - [Maintain a TiKV cluster using TiUP](../maintain) 16 | -------------------------------------------------------------------------------- /content/docs/6.5/deploy/operate/operate.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Operate TiKV 3 | description: Learn how to maintain and operate a TiKV cluster. 4 | menu: 5 | "6.5": 6 | parent: Deploy-6.5 7 | weight: 5 8 | identifier: Operate TiKV-6.5 9 | --- 10 | 11 | This section introduces how to maintain and operate a TiKV cluster, including the following operations: 12 | 13 | - [Upgrade a TiKV cluster using TiUP](../upgrade) 14 | - [Scale out/in a TiKV cluster using TiUP](../scale) 15 | - [Maintain a TiKV cluster using TiUP](../maintain) 16 | -------------------------------------------------------------------------------- /content/docs/7.1/deploy/operate/operate.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Operate TiKV 3 | description: Learn how to maintain and operate a TiKV cluster. 4 | menu: 5 | "7.1": 6 | parent: Deploy-7.1 7 | weight: 5 8 | identifier: Operate TiKV-7.1 9 | --- 10 | 11 | This section introduces how to maintain and operate a TiKV cluster, including the following operations: 12 | 13 | - [Upgrade a TiKV cluster using TiUP](../upgrade) 14 | - [Scale out/in a TiKV cluster using TiUP](../scale) 15 | - [Maintain a TiKV cluster using TiUP](../maintain) 16 | -------------------------------------------------------------------------------- /content/docs/dev/deploy/operate/operate.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Operate TiKV 3 | description: Learn how to maintain and operate a TiKV cluster. 4 | menu: 5 | "dev": 6 | parent: Deploy-dev 7 | weight: 5 8 | identifier: Operate TiKV-dev 9 | --- 10 | 11 | This section introduces how to maintain and operate a TiKV cluster, including the following operations: 12 | 13 | - [Upgrade a TiKV cluster using TiUP](../upgrade) 14 | - [Scale out/in a TiKV cluster using TiUP](../scale) 15 | - [Maintain a TiKV cluster using TiUP](../maintain) 16 | -------------------------------------------------------------------------------- /content/docs/5.1/reference/CLI/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: CLI 3 | description: Command-line interface tools used to administrate TiKV clusters 4 | menu: 5 | "5.1": 6 | parent: Reference 7 | weight: 4 8 | --- 9 | 10 | You can use the following command-line interface tools to administrate TiKV clusters: 11 | 12 | * [`tikv-ctl`](../tikv-ctl): A control plane tool for managing TiKV, both online and offline. 13 | * [`pd-ctl`](../pd-ctl): A control plane tool for managing PD. 14 | * [`pd-recover`](../pd-recover): A disaster recovery tool for PD. 15 | -------------------------------------------------------------------------------- /content/docs/6.1/deploy/monitor/monitor.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Monitor and Alert 3 | description: Learn how to monitor a TiKV cluster. 4 | menu: 5 | "6.1": 6 | parent: Deploy-v6.1 7 | weight: 4 8 | identifier: Monitor and Alert-v6.1 9 | --- 10 | 11 | This section introduces how to monitor a TiKV cluster. 12 | 13 | - [Monitor Framework](../framework) 14 | - [Monitor API](../api) 15 | - [Deploy Monitoring Services](../deploy) 16 | - [Export Grafana Shapshots](../grafana) 17 | - [Key Metrics](../key-metrics) 18 | - [TiKV Cluster Alert Rules](../alert) 19 | -------------------------------------------------------------------------------- /content/docs/6.5/deploy/monitor/monitor.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Monitor and Alert 3 | description: Learn how to monitor a TiKV cluster. 4 | menu: 5 | "6.5": 6 | parent: Deploy-6.5 7 | weight: 4 8 | identifier: Monitor and Alert-6.5 9 | --- 10 | 11 | This section introduces how to monitor a TiKV cluster. 12 | 13 | - [Monitor Framework](../framework) 14 | - [Monitor API](../api) 15 | - [Deploy Monitoring Services](../deploy) 16 | - [Export Grafana Shapshots](../grafana) 17 | - [Key Metrics](../key-metrics) 18 | - [TiKV Cluster Alert Rules](../alert) 19 | -------------------------------------------------------------------------------- /content/docs/7.1/deploy/monitor/monitor.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Monitor and Alert 3 | description: Learn how to monitor a TiKV cluster. 4 | menu: 5 | "7.1": 6 | parent: Deploy-7.1 7 | weight: 4 8 | identifier: Monitor and Alert-7.1 9 | --- 10 | 11 | This section introduces how to monitor a TiKV cluster. 12 | 13 | - [Monitor Framework](../framework) 14 | - [Monitor API](../api) 15 | - [Deploy Monitoring Services](../deploy) 16 | - [Export Grafana Shapshots](../grafana) 17 | - [Key Metrics](../key-metrics) 18 | - [TiKV Cluster Alert Rules](../alert) 19 | -------------------------------------------------------------------------------- /content/docs/dev/deploy/monitor/monitor.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Monitor and Alert 3 | description: Learn how to monitor a TiKV cluster. 4 | menu: 5 | "dev": 6 | parent: Deploy-dev 7 | weight: 4 8 | identifier: Monitor and Alert-dev 9 | --- 10 | 11 | This section introduces how to monitor a TiKV cluster. 12 | 13 | - [Monitor Framework](../framework) 14 | - [Monitor API](../api) 15 | - [Deploy Monitoring Services](../deploy) 16 | - [Export Grafana Shapshots](../grafana) 17 | - [Key Metrics](../key-metrics) 18 | - [TiKV Cluster Alert Rules](../alert) 19 | -------------------------------------------------------------------------------- /content/docs/3.0/tasks/deploy/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Deploy 3 | description: TiKV deployment prerequisites and methods 4 | menu: 5 | "3.0": 6 | parent: Tasks 7 | weight: 2 8 | name: Deploy 9 | --- 10 | 11 | This section introduces the prerequisites for deploying TiKV and how to deploy a TiKV cluster. 12 | 13 | - [Prerequisites](../prerequisites) 14 | - [Deploy TiKV using Ansible](../ansible) 15 | - [Deploy TiKV using Docker](../docker) 16 | - [Deploy TiKV using binary files](../binary) 17 | - [Deploy TiKV using Docker Compose/Swarm](../docker-compose) 18 | -------------------------------------------------------------------------------- /content/docs/4.0/tasks/deploy/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Deploy 3 | description: TiKV deployment prerequisites and methods 4 | menu: 5 | "4.0": 6 | parent: Tasks 7 | weight: 2 8 | name: Deploy 9 | --- 10 | 11 | This section introduces the prerequisites for deploying TiKV and how to deploy a TiKV cluster. 12 | 13 | - [Prerequisites](../prerequisites) 14 | - [Deploy TiKV using Ansible](../ansible) 15 | - [Deploy TiKV using Docker](../docker) 16 | - [Deploy TiKV using binary files](../binary) 17 | - [Deploy TiKV using Docker Compose/Swarm](../docker-compose) 18 | -------------------------------------------------------------------------------- /content/docs/3.0/reference/query-layers.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Query Layers 3 | description: Extend TiKV using stateless query layers 4 | menu: 5 | "3.0": 6 | parent: Reference 7 | weight: 3 8 | --- 9 | 10 | There are several projects which harness TiKV to power their storage: 11 | 12 | * [TiDB](https://github.com/pingcap/tidb) (MySQL) 13 | * [TiPrometheus](https://github.com/bragfoo/TiPrometheus) (Prometheus) 14 | * [Titan](https://github.com/distributedio/titan) (Redis) 15 | * [Tidis](https://github.com/yongman/tidis) (Redis) 16 | * [Titea](https://github.com/gengmei-tech/titea) (Redis) -------------------------------------------------------------------------------- /content/docs/4.0/reference/query-layers.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Query Layers 3 | description: Extend TiKV using stateless query layers 4 | menu: 5 | "4.0": 6 | parent: Reference 7 | weight: 3 8 | --- 9 | 10 | There are several projects which harness TiKV to power their storage: 11 | 12 | * [TiDB](https://github.com/pingcap/tidb) (MySQL) 13 | * [TiPrometheus](https://github.com/bragfoo/TiPrometheus) (Prometheus) 14 | * [Titan](https://github.com/distributedio/titan) (Redis) 15 | * [Tidis](https://github.com/yongman/tidis) (Redis) 16 | * [Titea](https://github.com/gengmei-tech/titea) (Redis) -------------------------------------------------------------------------------- /content/docs/6.5/reference/CLI/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: CLI 3 | description: Command-line interface tools used to administrate TiKV clusters 4 | menu: 5 | "6.5": 6 | parent: Reference-6.5 7 | weight: 4 8 | identifier: CLI-6.5 9 | --- 10 | 11 | You can use the following command-line interface tools to administrate TiKV clusters: 12 | 13 | * [`tikv-ctl`](../tikv-ctl): A control plane tool for managing TiKV, both online and offline. 14 | * [`pd-ctl`](../pd-ctl): A control plane tool for managing PD. 15 | * [`pd-recover`](../pd-recover): A disaster recovery tool for PD. 16 | -------------------------------------------------------------------------------- /content/docs/7.1/reference/CLI/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: CLI 3 | description: Command-line interface tools used to administrate TiKV clusters 4 | menu: 5 | "7.1": 6 | parent: Reference-7.1 7 | weight: 4 8 | identifier: CLI-7.1 9 | --- 10 | 11 | You can use the following command-line interface tools to administrate TiKV clusters: 12 | 13 | * [`tikv-ctl`](../tikv-ctl): A control plane tool for managing TiKV, both online and offline. 14 | * [`pd-ctl`](../pd-ctl): A control plane tool for managing PD. 15 | * [`pd-recover`](../pd-recover): A disaster recovery tool for PD. 16 | -------------------------------------------------------------------------------- /content/docs/dev/reference/CLI/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: CLI 3 | description: Command-line interface tools used to administrate TiKV clusters 4 | menu: 5 | "dev": 6 | parent: Reference-dev 7 | weight: 4 8 | identifier: CLI-dev 9 | --- 10 | 11 | You can use the following command-line interface tools to administrate TiKV clusters: 12 | 13 | * [`tikv-ctl`](../tikv-ctl): A control plane tool for managing TiKV, both online and offline. 14 | * [`pd-ctl`](../pd-ctl): A control plane tool for managing PD. 15 | * [`pd-recover`](../pd-recover): A disaster recovery tool for PD. 16 | -------------------------------------------------------------------------------- /content/docs/6.1/reference/CLI/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: CLI 3 | description: Command-line interface tools used to administrate TiKV clusters 4 | menu: 5 | "6.1": 6 | parent: Reference-v6.1 7 | weight: 4 8 | identifier: CLI-v6.1 9 | --- 10 | 11 | You can use the following command-line interface tools to administrate TiKV clusters: 12 | 13 | * [`tikv-ctl`](../tikv-ctl): A control plane tool for managing TiKV, both online and offline. 14 | * [`pd-ctl`](../pd-ctl): A control plane tool for managing PD. 15 | * [`pd-recover`](../pd-recover): A disaster recovery tool for PD. 16 | -------------------------------------------------------------------------------- /content/docs/5.1/reference/architecture/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Architecture 3 | description: How TiKV works and how it is built. 4 | menu: 5 | "5.1": 6 | parent: Reference 7 | weight: 1 8 | --- 9 | 10 | This chapter introduces how TiKV works and how it is built: 11 | 12 | - [Overview](../overview): Provides an overview of TiKV architecture. 13 | - [Storage](../storage): Introduces the storage layer of a TiKV cluster. 14 | - [Scheduling](../scheduling): Introduces the PD scheduling component in a TiKV cluster. 15 | - [Terminology](../terminology): Explains TiKV and PD terminologies. 16 | -------------------------------------------------------------------------------- /layouts/partials/open-graph-tags.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | {{ if .Description }} 5 | 6 | {{ else if .Summary }} 7 | 8 | {{ else }} 9 | 10 | {{ end }} 11 | 12 | -------------------------------------------------------------------------------- /layouts/_default/single.html: -------------------------------------------------------------------------------- 1 | {{ define "main" }} 2 | {{ partial "navbar.html" . }} 3 | 4 |
5 |
6 |
7 |

8 | {{ .Title }} 9 |

10 |
11 |
12 |
13 | 14 |
15 |
16 |
17 |
18 |
19 | {{ .Content }} 20 |
21 |
22 |
23 |
24 |
25 | {{ end }} 26 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | yarn: 2 | yarn 3 | 4 | serve: yarn 5 | hugo server \ 6 | --buildDrafts \ 7 | --buildFuture \ 8 | --disableFastRender \ 9 | --bind 0.0.0.0 10 | 11 | serve-production: yarn 12 | hugo server \ 13 | --disableFastRender \ 14 | --buildFuture \ 15 | --bind 0.0.0.0 16 | 17 | production-build: yarn 18 | hugo --minify \ 19 | --buildFuture 20 | 21 | preview-build: yarn 22 | hugo \ 23 | --buildDrafts \ 24 | --buildFuture \ 25 | --baseURL $(DEPLOY_PRIME_URL) \ 26 | --minify 27 | 28 | docker: 29 | docker build -t tikv/website . 30 | docker run -it --rm -p 1313:1313 -v `pwd`:/home/builder/build tikv/website -------------------------------------------------------------------------------- /data/users.yaml: -------------------------------------------------------------------------------- 1 | - name: dailymotion 2 | logo: img/homepage/logo-dailymotion.png 3 | - name: ZaloPay 4 | logo: img/homepage/logo-ZaloPay.png 5 | - name: pingan 6 | logo: img/homepage/logo-pingan.png 7 | - name: JDCloud 8 | logo: img/homepage/logo-JDCloud.png 9 | - name: tidbcloud 10 | logo: img/homepage/logo-tidbcloud.png 11 | - name: meitu 12 | logo: img/homepage/logo-meitu.png 13 | - name: zhuanzhuan 14 | logo: img/homepage/logo-zhuanzhuan.png 15 | - name: ctrip 16 | logo: img/homepage/logo-ctrip.png 17 | - name: tuya 18 | logo: img/homepage/logo-tuya.png 19 | - name: juicefs 20 | logo: img/homepage/logo-juicefs.svg 21 | -------------------------------------------------------------------------------- /content/docs/5.1/develop/rawkv/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: RawKV 3 | description: How to interact with TiKV using RawKV API. 4 | menu: 5 | "5.1": 6 | parent: Develop 7 | weight: 2 8 | --- 9 | 10 | TiKV supports both transactional (TxnKV) API and non-transactional (RawKV) API. This chapter walks you through a few demonstrations about how to use RawKV API. 11 | 12 | - [Get Put Delete](../get-put-delete/) 13 | - [Scan](../scan) 14 | - [Time to Live (TTL)](../ttl) 15 | - [Compare And Swap (CAS)](../cas) 16 | 17 | To get the example code in this chapter, click [here](https://github.com/marsishandsome/tikv-client-examples). 18 | -------------------------------------------------------------------------------- /content/docs/6.5/reference/architecture/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Architecture 3 | description: How TiKV works and how it is built. 4 | menu: 5 | "6.5": 6 | parent: Reference-6.5 7 | weight: 1 8 | identifier: Architecture-6.5 9 | --- 10 | 11 | This chapter introduces how TiKV works and how it is built: 12 | 13 | - [Overview](../overview): Provides an overview of TiKV architecture. 14 | - [Storage](../storage): Introduces the storage layer of a TiKV cluster. 15 | - [Scheduling](../scheduling): Introduces the PD scheduling component in a TiKV cluster. 16 | - [Terminology](../terminology): Explains TiKV and PD terminologies. 17 | -------------------------------------------------------------------------------- /content/docs/7.1/reference/architecture/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Architecture 3 | description: How TiKV works and how it is built. 4 | menu: 5 | "7.1": 6 | parent: Reference-7.1 7 | weight: 1 8 | identifier: Architecture-7.1 9 | --- 10 | 11 | This chapter introduces how TiKV works and how it is built: 12 | 13 | - [Overview](../overview): Provides an overview of TiKV architecture. 14 | - [Storage](../storage): Introduces the storage layer of a TiKV cluster. 15 | - [Scheduling](../scheduling): Introduces the PD scheduling component in a TiKV cluster. 16 | - [Terminology](../terminology): Explains TiKV and PD terminologies. 17 | -------------------------------------------------------------------------------- /content/docs/dev/reference/architecture/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Architecture 3 | description: How TiKV works and how it is built. 4 | menu: 5 | "dev": 6 | parent: Reference-dev 7 | weight: 1 8 | identifier: Architecture-dev 9 | --- 10 | 11 | This chapter introduces how TiKV works and how it is built: 12 | 13 | - [Overview](../overview): Provides an overview of TiKV architecture. 14 | - [Storage](../storage): Introduces the storage layer of a TiKV cluster. 15 | - [Scheduling](../scheduling): Introduces the PD scheduling component in a TiKV cluster. 16 | - [Terminology](../terminology): Explains TiKV and PD terminologies. 17 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/question.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: "\U0001F914 Question" 3 | about: Usage question that isn't answered in docs or discussion 4 | --- 5 | 6 | ## Question 7 | 8 | 10 | 11 | Before submitting your question, make sure you have: 12 | 13 | - Searched existing Stack Overflow questions. 14 | - Googled your question. 15 | - Searched the open and closed [GitHub issues](https://github.com/tikv/website/issues). 16 | 17 | Now, please describe your question here: 18 | -------------------------------------------------------------------------------- /content/docs/5.1/reference/query-layers.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Query Layers 3 | description: Extend TiKV using stateless query layers 4 | menu: 5 | "5.1": 6 | parent: Reference 7 | weight: 2 8 | --- 9 | 10 | TiKV works as storage engines for the following projects: 11 | 12 | * [TiDB](https://github.com/pingcap/tidb) (MySQL) 13 | * [Zetta](https://github.com/zhihu/zetta) (Table Store & HBase) 14 | * [Tidis](https://github.com/yongman/tidis) (Redis) 15 | * [Titan](https://github.com/distributedio/titan) (Redis) 16 | * [Titea](https://github.com/gengmei-tech/titea) (Redis) 17 | * [TiPrometheus](https://github.com/bragfoo/TiPrometheus) (Prometheus) 18 | -------------------------------------------------------------------------------- /content/docs/6.1/reference/architecture/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Architecture 3 | description: How TiKV works and how it is built. 4 | menu: 5 | "6.1": 6 | parent: Reference-v6.1 7 | weight: 1 8 | identifier: Architecture-v6.1 9 | --- 10 | 11 | This chapter introduces how TiKV works and how it is built: 12 | 13 | - [Overview](../overview): Provides an overview of TiKV architecture. 14 | - [Storage](../storage): Introduces the storage layer of a TiKV cluster. 15 | - [Scheduling](../scheduling): Introduces the PD scheduling component in a TiKV cluster. 16 | - [Terminology](../terminology): Explains TiKV and PD terminologies. 17 | -------------------------------------------------------------------------------- /content/docs/5.1/develop/clients/cpp.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: C++ Client 3 | description: Interact with TiKV using C++. 4 | menu: 5 | "5.1": 6 | parent: TiKV Clients 7 | weight: 5 8 | --- 9 | 10 | {{< warning >}} 11 | Currently, the TiKV client for C++ is not released yet. 12 | {{< /warning >}} 13 | 14 | The TiKV client for C++ is built on top of [TiKV client for Rust](https://github.com/tikv/client-rust) using [cxx](https://github.com/dtolnay/cxx). 15 | 16 | This C++ client is still in the proof-of-concept stage and under development. You can track the development progress at the [tikv/client-cpp](https://github.com/tikv/client-cpp/) repository. 17 | -------------------------------------------------------------------------------- /layouts/shortcodes/config.html: -------------------------------------------------------------------------------- 1 | {{ $group := .Get 0 }} 2 | {{ $configs := index site.Data.configs $group }} 3 | 4 | 5 | 6 | 9 | 12 | 15 | 16 | 17 | 18 | {{ range $configs }} 19 | 20 | 23 | 26 | 29 | 30 | {{ end }} 31 | 32 |
7 | Name 8 | 10 | Description 11 | 13 | Default 14 |
21 | {{ .name }} 22 | 24 | {{ .description | markdownify }} 25 | 27 | {{ .default }} 28 |
33 | -------------------------------------------------------------------------------- /layouts/partials/javascript.html: -------------------------------------------------------------------------------- 1 | {{ $inServerMode := site.IsServer }} 2 | {{ $jsFiles := site.Params.assets.js }} 3 | {{ range $jsFiles }} 4 | {{ $path := printf "js/%s.js" . }} 5 | {{ $js := resources.Get $path }} 6 | {{ if $inServerMode }} 7 | 8 | {{ else }} 9 | {{ $prodJs := $js | minify | fingerprint }} 10 | 11 | {{ end }} 12 | {{ end }} 13 | {{ if .Params.mathjax }} 14 | 16 | {{ end }} 17 | -------------------------------------------------------------------------------- /content/docs/6.1/develop/rawkv/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: RawKV 3 | description: How to interact with TiKV using RawKV API. 4 | menu: 5 | "6.1": 6 | parent: Develop-v6.1 7 | weight: 2 8 | identifier: RawKV-v6.1 9 | --- 10 | 11 | TiKV supports both transactional (TxnKV) API and non-transactional (RawKV) API. This chapter walks you through a few demonstrations about how to use RawKV API. 12 | 13 | - [Get Put Delete](../get-put-delete/) 14 | - [Scan](../scan) 15 | - [Time to Live (TTL)](../ttl) 16 | - [Compare And Swap (CAS)](../cas) 17 | 18 | To get the example code in this chapter, click [here](https://github.com/marsishandsome/tikv-client-examples). 19 | -------------------------------------------------------------------------------- /layouts/partials/twitter-card.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | {{ if .Description }} 6 | 7 | {{ else if .Summary }} 8 | 9 | {{ else }} 10 | 11 | {{ end }} 12 | 13 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/change-request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: "\U0001F680 Change Request" 3 | about: Any suggestion? Want to add something new? 4 | --- 5 | 6 | ## Change Request 7 | 8 | 10 | 11 | ### Describe the problem 12 | 13 | - Relevant URL(s): 14 | 15 | 16 | 17 | ### Suggest an improvement/fix 18 | 19 | 20 | -------------------------------------------------------------------------------- /content/community/sig-coprocessor.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Coprocessor SIG 3 | description: Information about the coprocessor special interest group 4 | --- 5 | 6 | Coprocessor SIG focuses on the Coprocessor module of the TiKV project, which is the module in TiKV that handles TiDB's pushdown calculations. The primary responsibility of this SIG is to discuss, plan, develop, and maintain the future development of the Coprocessor module. 7 | 8 | For more information, see [our page](https://github.com/tikv/community/tree/master/sig/coprocessor) in the TiKV community repo. 9 | 10 | You can contact the coprocessor SIG via [Slack](https://slack.tidb.io/invite?team=tikv-wg&channel=sig-copr&ref=github_sig). 11 | -------------------------------------------------------------------------------- /content/docs/5.1/develop/clients/python.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Python Client 3 | description: Interact with TiKV using Python. 4 | menu: 5 | "5.1": 6 | parent: TiKV Clients 7 | weight: 4 8 | --- 9 | 10 | TiKV client for python is built on top of [TiKV Client in Rust](https://github.com/tikv/client-rust) via CFFI and [PyO3 Python binding](https://github.com/PyO3/pyo3). 11 | 12 | The Python client is still in the proof-of-concept stage and under development. You can track the development at [tikv/client-py](https://github.com/tikv/client-py/) repository. 13 | 14 | {{< warning >}} 15 | You should not use the Python client for production use until it is released. 16 | {{< /warning >}} 17 | -------------------------------------------------------------------------------- /content/docs/6.5/develop/clients/cpp.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: C++ Client 3 | description: Interact with TiKV using C++. 4 | menu: 5 | "6.5": 6 | parent: TiKV Clients-6.5 7 | weight: 5 8 | identifier: C++ Client-6.5 9 | --- 10 | 11 | {{< warning >}} 12 | Currently, the TiKV client for C++ is not released yet. 13 | {{< /warning >}} 14 | 15 | The TiKV client for C++ is built on top of [TiKV client for Rust](https://github.com/tikv/client-rust) using [cxx](https://github.com/dtolnay/cxx). 16 | 17 | This C++ client is still in the proof-of-concept stage and under development. You can track the development progress at the [tikv/client-cpp](https://github.com/tikv/client-cpp/) repository. 18 | -------------------------------------------------------------------------------- /content/docs/7.1/develop/clients/cpp.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: C++ Client 3 | description: Interact with TiKV using C++. 4 | menu: 5 | "7.1": 6 | parent: TiKV Clients-7.1 7 | weight: 5 8 | identifier: C++ Client-7.1 9 | --- 10 | 11 | {{< warning >}} 12 | Currently, the TiKV client for C++ is not released yet. 13 | {{< /warning >}} 14 | 15 | The TiKV client for C++ is built on top of [TiKV client for Rust](https://github.com/tikv/client-rust) using [cxx](https://github.com/dtolnay/cxx). 16 | 17 | This C++ client is still in the proof-of-concept stage and under development. You can track the development progress at the [tikv/client-cpp](https://github.com/tikv/client-cpp/) repository. 18 | -------------------------------------------------------------------------------- /content/docs/dev/develop/clients/cpp.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: C++ Client 3 | description: Interact with TiKV using C++. 4 | menu: 5 | "dev": 6 | parent: TiKV Clients-dev 7 | weight: 5 8 | identifier: C++ Client-dev 9 | --- 10 | 11 | {{< warning >}} 12 | Currently, the TiKV client for C++ is not released yet. 13 | {{< /warning >}} 14 | 15 | The TiKV client for C++ is built on top of [TiKV client for Rust](https://github.com/tikv/client-rust) using [cxx](https://github.com/dtolnay/cxx). 16 | 17 | This C++ client is still in the proof-of-concept stage and under development. You can track the development progress at the [tikv/client-cpp](https://github.com/tikv/client-cpp/) repository. 18 | -------------------------------------------------------------------------------- /content/docs/6.1/develop/clients/cpp.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: C++ Client 3 | description: Interact with TiKV using C++. 4 | menu: 5 | "6.1": 6 | parent: TiKV Clients-v6.1 7 | weight: 5 8 | identifier: C++ Client-v6.1 9 | --- 10 | 11 | {{< warning >}} 12 | Currently, the TiKV client for C++ is not released yet. 13 | {{< /warning >}} 14 | 15 | The TiKV client for C++ is built on top of [TiKV client for Rust](https://github.com/tikv/client-rust) using [cxx](https://github.com/dtolnay/cxx). 16 | 17 | This C++ client is still in the proof-of-concept stage and under development. You can track the development progress at the [tikv/client-cpp](https://github.com/tikv/client-cpp/) repository. 18 | -------------------------------------------------------------------------------- /content/docs/6.1/reference/query-layers.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Query Layers 3 | description: Extend TiKV using stateless query layers 4 | menu: 5 | "6.1": 6 | parent: Reference-v6.1 7 | weight: 2 8 | identifier: Query Layers-v6.1 9 | --- 10 | 11 | TiKV works as storage engines for the following projects: 12 | 13 | * [TiDB](https://github.com/pingcap/tidb) (MySQL) 14 | * [Zetta](https://github.com/zhihu/zetta) (Table Store & HBase) 15 | * [Tidis](https://github.com/yongman/tidis) (Redis) 16 | * [Titan](https://github.com/distributedio/titan) (Redis) 17 | * [Titea](https://github.com/gengmei-tech/titea) (Redis) 18 | * [TiPrometheus](https://github.com/bragfoo/TiPrometheus) (Prometheus) 19 | -------------------------------------------------------------------------------- /content/docs/6.5/reference/query-layers.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Query Layers 3 | description: Extend TiKV using stateless query layers 4 | menu: 5 | "6.5": 6 | parent: Reference-6.5 7 | weight: 2 8 | identifier: Query Layers-6.5 9 | --- 10 | 11 | TiKV works as storage engines for the following projects: 12 | 13 | * [TiDB](https://github.com/pingcap/tidb) (MySQL) 14 | * [Zetta](https://github.com/zhihu/zetta) (Table Store & HBase) 15 | * [Tidis](https://github.com/yongman/tidis) (Redis) 16 | * [Titan](https://github.com/distributedio/titan) (Redis) 17 | * [Titea](https://github.com/gengmei-tech/titea) (Redis) 18 | * [TiPrometheus](https://github.com/bragfoo/TiPrometheus) (Prometheus) 19 | -------------------------------------------------------------------------------- /content/docs/7.1/reference/query-layers.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Query Layers 3 | description: Extend TiKV using stateless query layers 4 | menu: 5 | "7.1": 6 | parent: Reference-7.1 7 | weight: 2 8 | identifier: Query Layers-7.1 9 | --- 10 | 11 | TiKV works as storage engines for the following projects: 12 | 13 | * [TiDB](https://github.com/pingcap/tidb) (MySQL) 14 | * [Zetta](https://github.com/zhihu/zetta) (Table Store & HBase) 15 | * [Tidis](https://github.com/yongman/tidis) (Redis) 16 | * [Titan](https://github.com/distributedio/titan) (Redis) 17 | * [Titea](https://github.com/gengmei-tech/titea) (Redis) 18 | * [TiPrometheus](https://github.com/bragfoo/TiPrometheus) (Prometheus) 19 | -------------------------------------------------------------------------------- /content/docs/dev/reference/query-layers.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Query Layers 3 | description: Extend TiKV using stateless query layers 4 | menu: 5 | "dev": 6 | parent: Reference-dev 7 | weight: 2 8 | identifier: Query Layers-dev 9 | --- 10 | 11 | TiKV works as storage engines for the following projects: 12 | 13 | * [TiDB](https://github.com/pingcap/tidb) (MySQL) 14 | * [Zetta](https://github.com/zhihu/zetta) (Table Store & HBase) 15 | * [Tidis](https://github.com/yongman/tidis) (Redis) 16 | * [Titan](https://github.com/distributedio/titan) (Redis) 17 | * [Titea](https://github.com/gengmei-tech/titea) (Redis) 18 | * [TiPrometheus](https://github.com/bragfoo/TiPrometheus) (Prometheus) 19 | -------------------------------------------------------------------------------- /content/docs/6.5/develop/rawkv/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: RawKV 3 | description: How to interact with TiKV using RawKV API. 4 | menu: 5 | "6.5": 6 | parent: Develop-6.5 7 | weight: 2 8 | identifier: RawKV-6.5 9 | --- 10 | 11 | TiKV supports both transactional (TxnKV) API and non-transactional (RawKV) API. This chapter walks you through a few demonstrations about how to use RawKV API. 12 | 13 | - [Get Put Delete](../get-put-delete/) 14 | - [Scan](../scan) 15 | - [Time to Live (TTL)](../ttl) 16 | - [Compare And Swap (CAS)](../cas) 17 | - [Checksum](../checksum) 18 | 19 | To get the example code in this chapter, click [here](https://github.com/marsishandsome/tikv-client-examples). 20 | -------------------------------------------------------------------------------- /content/docs/7.1/develop/rawkv/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: RawKV 3 | description: How to interact with TiKV using RawKV API. 4 | menu: 5 | "7.1": 6 | parent: Develop-7.1 7 | weight: 2 8 | identifier: RawKV-7.1 9 | --- 10 | 11 | TiKV supports both transactional (TxnKV) API and non-transactional (RawKV) API. This chapter walks you through a few demonstrations about how to use RawKV API. 12 | 13 | - [Get Put Delete](../get-put-delete/) 14 | - [Scan](../scan) 15 | - [Time to Live (TTL)](../ttl) 16 | - [Compare And Swap (CAS)](../cas) 17 | - [Checksum](../checksum) 18 | 19 | To get the example code in this chapter, click [here](https://github.com/marsishandsome/tikv-client-examples). 20 | -------------------------------------------------------------------------------- /content/docs/dev/develop/rawkv/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: RawKV 3 | description: How to interact with TiKV using RawKV API. 4 | menu: 5 | "dev": 6 | parent: Develop-dev 7 | weight: 2 8 | identifier: RawKV-dev 9 | --- 10 | 11 | TiKV supports both transactional (TxnKV) API and non-transactional (RawKV) API. This chapter walks you through a few demonstrations about how to use RawKV API. 12 | 13 | - [Get Put Delete](../get-put-delete/) 14 | - [Scan](../scan) 15 | - [Time to Live (TTL)](../ttl) 16 | - [Compare And Swap (CAS)](../cas) 17 | - [Checksum](../checksum) 18 | 19 | To get the example code in this chapter, click [here](https://github.com/marsishandsome/tikv-client-examples). 20 | -------------------------------------------------------------------------------- /static/img/homepage/get-started.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | -------------------------------------------------------------------------------- /content/docs/6.5/develop/clients/python.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Python Client 3 | description: Interact with TiKV using Python. 4 | menu: 5 | "6.5": 6 | parent: TiKV Clients-6.5 7 | weight: 4 8 | identifier: Python Client-6.5 9 | --- 10 | 11 | TiKV client for python is built on top of [TiKV Client in Rust](https://github.com/tikv/client-rust) via CFFI and [PyO3 Python binding](https://github.com/PyO3/pyo3). 12 | 13 | The Python client is still in the proof-of-concept stage and under development. You can track the development at [tikv/client-py](https://github.com/tikv/client-py/) repository. 14 | 15 | {{< warning >}} 16 | You should not use the Python client for production use until it is released. 17 | {{< /warning >}} 18 | -------------------------------------------------------------------------------- /content/docs/7.1/develop/clients/python.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Python Client 3 | description: Interact with TiKV using Python. 4 | menu: 5 | "7.1": 6 | parent: TiKV Clients-7.1 7 | weight: 4 8 | identifier: Python Client-7.1 9 | --- 10 | 11 | TiKV client for python is built on top of [TiKV Client in Rust](https://github.com/tikv/client-rust) via CFFI and [PyO3 Python binding](https://github.com/PyO3/pyo3). 12 | 13 | The Python client is still in the proof-of-concept stage and under development. You can track the development at [tikv/client-py](https://github.com/tikv/client-py/) repository. 14 | 15 | {{< warning >}} 16 | You should not use the Python client for production use until it is released. 17 | {{< /warning >}} 18 | -------------------------------------------------------------------------------- /content/docs/dev/develop/clients/python.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Python Client 3 | description: Interact with TiKV using Python. 4 | menu: 5 | "dev": 6 | parent: TiKV Clients-dev 7 | weight: 4 8 | identifier: Python Client-dev 9 | --- 10 | 11 | TiKV client for python is built on top of [TiKV Client in Rust](https://github.com/tikv/client-rust) via CFFI and [PyO3 Python binding](https://github.com/PyO3/pyo3). 12 | 13 | The Python client is still in the proof-of-concept stage and under development. You can track the development at [tikv/client-py](https://github.com/tikv/client-py/) repository. 14 | 15 | {{< warning >}} 16 | You should not use the Python client for production use until it is released. 17 | {{< /warning >}} 18 | -------------------------------------------------------------------------------- /content/docs/6.1/develop/clients/python.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Python Client 3 | description: Interact with TiKV using Python. 4 | menu: 5 | "6.1": 6 | parent: TiKV Clients-v6.1 7 | weight: 4 8 | identifier: Python Client-v6.1 9 | --- 10 | 11 | TiKV client for python is built on top of [TiKV Client in Rust](https://github.com/tikv/client-rust) via CFFI and [PyO3 Python binding](https://github.com/PyO3/pyo3). 12 | 13 | The Python client is still in the proof-of-concept stage and under development. You can track the development at [tikv/client-py](https://github.com/tikv/client-py/) repository. 14 | 15 | {{< warning >}} 16 | You should not use the Python client for production use until it is released. 17 | {{< /warning >}} 18 | -------------------------------------------------------------------------------- /layouts/partials/math.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | -------------------------------------------------------------------------------- /layouts/shortcodes/features.html: -------------------------------------------------------------------------------- 1 | {{ $features := site.Data.features }} 2 | {{ if eq (.Get 0) "featured"}} 3 | {{ $features = where $features "featured" true }} 4 | {{ end }} 5 | 6 | 7 | 8 | 11 | 14 | 15 | 16 | 17 | {{ range $features }} 18 | {{ $link := .link | default "docs/3.0/concepts/architecture" }} 19 | {{ $url := $link | relURL }} 20 | 21 | 26 | 29 | 30 | {{ end }} 31 | 32 |
9 | Feature 10 | 12 | Description 13 |
22 | 23 | {{ .name }} 24 | 25 | 27 | {{ .description | markdownify }} 28 |
33 | -------------------------------------------------------------------------------- /content/docs/3.0/reference/tools/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Tools 3 | description: Tools which can be used to administrate TiKV 4 | menu: 5 | "3.0": 6 | parent: Reference 7 | weight: 3 8 | --- 9 | 10 | There are a number of components and tools involved in maintaining a TiKV deployment. 11 | 12 | You can browse documentation on: 13 | 14 | * [`tikv-server`](../tikv-server): The TiKV service stores data and serves client requests. 15 | * [`tikv-ctl`](../tikv-ctl): The control plane tool for managing TiKV, both online or offline. 16 | * [`pd-server`](../pd-server): The PD service manages cluster metadata and transaction timestamps. 17 | * [`pd-ctl`](../pd-ctl): The control plane tool for managing PD. 18 | * [`pd-recover`](../pd-recover): A disaster recovery tool for PD. -------------------------------------------------------------------------------- /content/docs/4.0/reference/tools/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Tools 3 | description: Tools which can be used to administrate TiKV 4 | menu: 5 | "4.0": 6 | parent: Reference 7 | weight: 3 8 | --- 9 | 10 | There are a number of components and tools involved in maintaining a TiKV deployment. 11 | 12 | You can browse documentation on: 13 | 14 | * [`tikv-server`](../tikv-server): The TiKV service stores data and serves client requests. 15 | * [`tikv-ctl`](../tikv-ctl): The control plane tool for managing TiKV, both online or offline. 16 | * [`pd-server`](../pd-server): The PD service manages cluster metadata and transaction timestamps. 17 | * [`pd-ctl`](../pd-ctl): The control plane tool for managing PD. 18 | * [`pd-recover`](../pd-recover): A disaster recovery tool for PD. -------------------------------------------------------------------------------- /static/img/homepage/deploy.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | -------------------------------------------------------------------------------- /layouts/shortcodes/figure.html: -------------------------------------------------------------------------------- 1 | {{ $imgSrcSet := or (isset .Params "src") (isset .Params "id") }} 2 | {{ if not $imgSrcSet }} 3 | {{ errorf "You must set either an id or an src in the figure at content/%s" $.Page.File.Path }} 4 | {{ end }} 5 | {{ $src := cond (isset .Params "id") (printf "https://www.lucidchart.com/publicSegments/view/%s/image.png" (index .Params "id")) (index .Params "src" | relURL) }} 6 | {{ $num := index .Params "number" }} 7 |
8 | 9 | {{ . }} 10 | 11 | {{ with (index .Params "caption") }} 12 |
13 | {{ with $num }}Figure {{ . }}. {{ end }}{{ . | markdownify }} 14 |
15 | {{ end }} 16 |
17 | -------------------------------------------------------------------------------- /layouts/deep-dive/list.html: -------------------------------------------------------------------------------- 1 | {{ define "title" }} 2 | TiKV | {{ .Title }} 3 | {{ end }} 4 | 5 | {{ define "main" }} 6 | {{ partial "docs/hero.html" . }} 7 | {{ $currentPage := . }} 8 | 9 |
10 |
11 |
12 |
13 |
14 | {{ partial "entry-tree.html" (dict "entries" .Site.Menus.nav "currentPage" $currentPage ) }} 15 |
16 |
17 | 18 |
19 |
20 | {{ partial "docs/version-warning.html" . }} 21 | {{ partial "math.html" . }} 22 | 23 | {{ .Content }} 24 |
25 |
26 |
27 |
28 |
29 | {{ end }} 30 | -------------------------------------------------------------------------------- /layouts/_default/baseof.html: -------------------------------------------------------------------------------- 1 | {{ $isHome := .IsHome }} 2 | {{ $isServer := site.IsServer }} 3 | {{ $pageType := cond $isHome "home" .Section }} 4 | 5 | 6 | 7 | 8 | {{ if not $isServer }} 9 | {{ partial "google-analytics.html" . }} 10 | {{ end }} 11 | {{ partial "meta.html" . }} 12 | {{ partial "twitter-card.html" . }} 13 | {{ partial "open-graph-tags.html" . }} 14 | {{ block "title" . }}{{ site.Title }} | {{ site.Params.description.brief }}{{ end }} 15 | {{ partial "css.html" . }} 16 | 17 | 18 | 19 | {{ partial "navbar.html" . }} 20 | 21 |
22 | {{ block "main" . }}{{ end }} 23 |
24 | 25 | {{ partial "footer.html" . }} 26 | {{ partial "javascript.html" . }} 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /assets/js/app.js: -------------------------------------------------------------------------------- 1 | function navbarToggle() { 2 | $(".navbar-burger").click(function () { 3 | $(".navbar-burger").toggleClass("is-active"); 4 | $(".navbar-menu").toggleClass("is-active"); 5 | $(".navbar-dropdown").removeClass("is-active"); 6 | }); 7 | } 8 | 9 | function docsAnchors() { 10 | anchors.options = { 11 | icon: "#", 12 | }; 13 | 14 | anchors.add(".docs-content h2, .docs-content h3, .docs-content h4"); 15 | } 16 | 17 | $(function () { 18 | navbarToggle(); 19 | docsAnchors(); 20 | 21 | console.log("Welcome to the TiKV docs!"); 22 | 23 | $(".navbar-link").click(function () { 24 | $(this).next().toggleClass("is-active"); 25 | }); 26 | 27 | $(".is-navbar-version").click(function () { 28 | $(".navbar-menu").removeClass("is-active"); 29 | if (window.matchMedia("(max-width: 1024px)").matches) { 30 | $(this).next().toggleClass("is-active"); 31 | } 32 | }); 33 | }); 34 | -------------------------------------------------------------------------------- /data/getStarted.yaml: -------------------------------------------------------------------------------- 1 | - title: Get Started 2 | icon: img/homepage/get-started.svg 3 | docs: 4 | - name: TiKV in 5 minutes 5 | link: /docs/6.1/concepts/tikv-in-5-minutes/ 6 | - name: Explore Capabilities 7 | link: /docs/6.1/concepts/explore-tikv-features/overview/ 8 | - title: Develop 9 | icon: img/homepage/develop.svg 10 | docs: 11 | - name: Common Dev Tasks 12 | link: /docs/6.1/develop/develop/ 13 | - name: TiKV clients 14 | link: /docs/6.1/develop/clients/introduction/ 15 | - name: RawKV 16 | link: /docs/6.1/develop/rawkv/introduction/ 17 | - title: Deploy 18 | icon: img/homepage/deploy.svg 19 | docs: 20 | - name: Install TiKV 21 | link: /docs/6.1/deploy/install/install/ 22 | - name: Configure TiKV 23 | link: /docs/6.1/deploy/configure/introduction/ 24 | - name: Benchmark and Performance 25 | link: /docs/6.1/deploy/performance/performance/ 26 | - name: Operate TiKV Cluster 27 | link: /docs/6.1/deploy/operate/operate/ 28 | -------------------------------------------------------------------------------- /layouts/shortcodes/adopters.html: -------------------------------------------------------------------------------- 1 | {{ $adopters := site.Data.adopters }} 2 | 3 | 4 | 5 | 8 | 11 | 14 | 15 | 16 | 17 | {{ range $adopters }} 18 | 19 | 24 | 27 | 40 | 41 | {{ end }} 42 | 43 |
6 | Company 7 | 9 | Industry 10 | 12 | Success story 13 |
20 | 21 | {{ .name }} 22 | 23 | 25 | {{ .industry }} 26 | 28 | {{ if .stories }} 29 | {{ $numStories := len .stories }} 30 | {{ range $idx, $story := .stories }} 31 | 32 | {{ $story.language }} 33 | 34 | {{ if ne (sub $numStories 1) $idx }} 35 |
36 | {{ end }} 37 | {{ end }} 38 | {{ end }} 39 |
44 | -------------------------------------------------------------------------------- /content/community/sig-scheduling.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Scheduling SIG 3 | description: Information about the scheduling special interest group 4 | --- 5 | 6 | Scheduling SIG covers the scheduling system for TiKV. Our work includes 7 | 8 | - supporting new scheduling policies and optimizing the existing scheduling systems 9 | - engineering optimizations 10 | 11 | ## How to get involved 12 | 13 | You can take a look at our [Wiki](https://github.com/tikv/pd/wiki) to learn about some basic concepts and pick up an issue or raise a proposal in [Scheduling SIG project](https://github.com/tikv/pd/projects/5). 14 | 15 | Also, you can join us in #sig-scheduling in the [TiKV community Slack](https://slack.tidb.io/invite?team=tikv-wg&channel=sig-scheduling&ref=github-sig) to discuss everything about the scheduling of distributed system. We use English and Chinese. 16 | 17 | For more information, see [our page](https://github.com/tikv/community/tree/master/sig/scheduling) in the TiKV community repo. 18 | -------------------------------------------------------------------------------- /layouts/docs/list.html: -------------------------------------------------------------------------------- 1 | {{ define "title" }} 2 | TiKV | {{ .Title }} 3 | {{ end }} 4 | 5 | {{ define "main" }} 6 | {{ partial "docs/hero.html" . }} 7 | {{ $currentPage := . }} 8 | {{ $version := trim (index (findRE "\\/(\\d+\\.)?(\\d+\\.)?(\\*|\\d+)(-\\w*)?\\/|dev\\/" $currentPage.Permalink) 0) "/" }} 9 | {{ $docs := (index .Site.Menus $version) }} 10 | 11 |
12 |
13 |
14 |
15 |
16 | {{ partial "entry-tree.html" (dict "entries" $docs "currentPage" $currentPage ) }} 17 |
18 |
19 | 20 |
21 |
22 | {{ partial "docs/version-warning.html" . }} 23 | {{ partial "math.html" . }} 24 | 25 | {{ .Content }} 26 |
27 |
28 |
29 |
30 |
31 | {{ end }} 32 | -------------------------------------------------------------------------------- /static/img/logos/icon/color/tikv-icon-color.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /static/img/logos/horizontal/color/tikv-horizontal-color.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /layouts/docs/single.html: -------------------------------------------------------------------------------- 1 | {{ define "title" }} 2 | TiKV | {{ .Title }} 3 | {{ end }} 4 | 5 | {{ define "main" }} 6 | {{ partial "docs/hero.html" . }} 7 | {{ $currentPage := . }} 8 | {{ $version := trim (index (findRE "\\/(\\d+\\.)?(\\d+\\.)?(\\*|\\d+)(-\\w*)?\\/|dev\\/" $currentPage.Permalink) 0) "/" }} 9 | {{ $docs := (index .Site.Menus $version) }} 10 | 11 |
12 |
13 |
14 |
15 |
16 | {{ partial "entry-tree.html" (dict "entries" $docs "currentPage" $currentPage ) }} 17 |
18 |
19 | 20 |
21 |
22 | {{ partial "docs/version-warning.html" . }} 23 | {{ partial "math.html" . }} 24 | 25 | {{ .Content }} 26 |
27 |
28 |
29 |
30 |
31 | {{ end }} 32 | -------------------------------------------------------------------------------- /static/img/logos/icon/black/tikv-icon-black.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /layouts/partials/css.html: -------------------------------------------------------------------------------- 1 | {{ $otherCss := site.Params.assets.css }} 2 | {{ $inServerMode := site.IsServer }} 3 | {{ $sass := "sass/style.sass" }} 4 | {{ $target := "css/style.css" }} 5 | {{ $includes := (slice "node_modules") }} 6 | {{ $cssDevOpts := (dict "targetPath" $target "includePaths" $includes "enableSourceMap" true) }} 7 | {{ $cssProdOpts := (dict "targetPath" $target "includePaths" $includes "outputStyle" "compressed") }} 8 | {{ $cssOpts := cond $inServerMode $cssDevOpts $cssProdOpts }} 9 | {{ $css := resources.Get $sass | resources.ExecuteAsTemplate $sass . | toCSS $cssOpts }} 10 | {{ if $inServerMode }} 11 | 12 | {{ else }} 13 | {{ $prodCss := $css | fingerprint }} 14 | 15 | {{ end }} 16 | {{ range $otherCss }} 17 | {{ $path := printf "css/%s.css" . | relURL }} 18 | 19 | {{ end }} 20 | -------------------------------------------------------------------------------- /layouts/deep-dive/single.html: -------------------------------------------------------------------------------- 1 | {{ define "title" }} 2 | TiKV | {{ .Title }} 3 | {{ end }} 4 | 5 | {{ define "main" }} 6 | {{ partial "docs/hero.html" . }} 7 | {{ $currentPage := . }} 8 | {{ $version := trim (index (findRE "\\/(\\d+\\.)?(\\d+\\.)?(\\*|\\d+)(-\\w*)?\\/|dev\\/" $currentPage.Permalink) 0) "/" }} 9 | {{ $docs := (index .Site.Menus $version) }} 10 | 11 |
12 |
13 |
14 |
15 |
16 | {{ partial "entry-tree.html" (dict "entries" .Site.Menus.nav "currentPage" $currentPage ) }} 17 |
18 |
19 | 20 |
21 |
22 | {{ partial "docs/version-warning.html" . }} 23 | {{ partial "math.html" . }} 24 | 25 | {{ .Content }} 26 |
27 |
28 |
29 |
30 |
31 | {{ end }} 32 | -------------------------------------------------------------------------------- /static/img/logos/horizontal/black/tikv-horizontal-black.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /static/img/logos/stacked/black/tikv-stacked-black.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /static/img/logos/stacked/color/tikv-stacked-color.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /content/deep-dive/resource-scheduling/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Resource scheduling 3 | aliases: ['/docs/deep-dive/resource-scheduling/introduction'] 4 | menu: 5 | nav: 6 | parent: Deep Dive 7 | weight: 7 8 | --- 9 | 10 | In a distributed database environment, resource scheduling needs to meet the following requirements: 11 | 12 | - Keeping data highly available: The scheduler needs to be able to manage data redundancy to keep the cluster available when some nodes fail. 13 | - Balance server load: The scheduler needs to balance the load to prevent a single node from becoming a performance bottleneck for the entire system. 14 | - Scalability: The scheduler needs to be able to scale to thousands of nodes. 15 | - Fault tolerance: The scheduling process must not be stopped by the breaking down caused by a single node failure. 16 | 17 | In the TiKV cluster, resource scheduling is done by the Placement Driver (PD). In this chapter, we will first introduce the design of two scheduling systems (Kubernetes and Mesos), followed by the design and implementation of scheduler and placement in PD. 18 | -------------------------------------------------------------------------------- /static/img/logos/icon/white/tikv-icon-white.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /static/img/logos/stacked/white/tikv-stacked-white.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /static/img/logos/horizontal/white-deprecated/tikv-horizontal-white.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /content/docs/5.1/deploy/configure/rocksdb.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: RocksDB Config 3 | description: Learn how to configure RocksDB engine in TiKV. 4 | menu: 5 | "5.1": 6 | parent: Configure TiKV 7 | weight: 8 8 | --- 9 | 10 | TiKV uses [RocksDB](https://rocksdb.org/) internally to store Raft logs and key-value pairs. 11 | 12 | TiKV creates two RocksDB instances on each Node: 13 | 14 | * One `rocksdb` instance that stores key-value data. 15 | * One `raftdb` instance that stores Raft logs and has a single column family called `raftdb.defaultcf`. 16 | 17 | The `rocksdb` instance has three column families: 18 | 19 | Column family | Purpose 20 | :-------------|:------- 21 | `rocksdb.defaultcf` | Stores actual KV pairs for TiKV 22 | `rocksdb.lockcf` | Stores transaction lock 23 | `rocksdb.writecf` | Stores transactions' commits and rollback records 24 | 25 | RocksDB can be configured on each column family. Here is an example: 26 | 27 | ```toml 28 | [rocksdb.writecf] 29 | whole-key-filtering = false 30 | ``` 31 | 32 | For more information about the RocksDB configuration parameters, see [RocksDB-related parameters](../tikv-configuration-file/#rocksdb). -------------------------------------------------------------------------------- /content/deep-dive/scalability/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Scalability 3 | aliases: ['/docs/deep-dive/scalability/introduction'] 4 | menu: 5 | nav: 6 | parent: Deep Dive 7 | weight: 5 8 | --- 9 | 10 | In the database field, scalability is the term we use to describe the capability of a system to handle a growing amount of work. Even if a system is working reliably and fast today, it doesn't mean it will necessarily work well in the future. One common reason for degradation is the increased load which exceeds what the system can process. In modern systems, the amount of data we handle can far outgrow our original expectations, so scalability is a critical consideration for the design of a database. 11 | 12 | A system whose performance improves after adding hardware, proportionally to the capacity added, is said to be a scalable system. TiKV is a highly scalable key-value store, especially comparing with other stand-alone key-value stores like [RocksDB](https://rocksdb.org/) and [LevelDB](https://github.com/google/leveldb). In this chapter we will talk about the two main ways of scaling, horizontal and vertical, and how TiKV provide strong scalability based on Raft. 13 | -------------------------------------------------------------------------------- /content/docs/6.1/develop/develop.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Develop 3 | description: Learn how to use TiKV Clients for different languages 4 | menu: 5 | "6.1": 6 | weight: 3 7 | identifier: Develop-v6.1 8 | --- 9 | 10 | Learn how to use TiKV Clients for different languages. 11 | 12 | ## [TiKV Clients](../clients/introduction/) 13 | 14 | TiKV provides the following clients developed in different programming languages: 15 | 16 | - [Java Client](../clients/java) is ready for production. 17 | - [Go Client](../clients/go) is ready for production. 18 | - [Rust Client](../clients/rust) is still in the proof-of-concept stage and under development. 19 | - [Python Client](../clients/python) is still in the proof-of-concept stage and under development. 20 | - [C++ Client](../clients/cpp) is still in the proof-of-concept stage and under development. 21 | 22 | ## RawKV and TxnKV 23 | 24 | TiKV provides both transactional (TxnKV) API and non-transactional (RawKV) API. 25 | 26 | Learn how to use [RawKV API](../rawkv/introduction/): 27 | 28 | - [Get Put Delete](../rawkv/get-put-delete/) 29 | - [Scan](../rawkv/scan) 30 | - [Time to Live (TTL)](../rawkv/ttl) 31 | - [Compare And Swap (CAS)](../rawkv/cas) 32 | -------------------------------------------------------------------------------- /content/docs/5.1/develop/develop.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Develop 3 | description: Learn how to use TiKV Clients for different languages 4 | menu: 5 | "5.1": 6 | weight: 2 7 | --- 8 | 9 | Learn how to use TiKV Clients for different languages. 10 | 11 | ## [TiKV Clients](../clients/introduction/) 12 | 13 | TiKV provides the following clients developed in different programming languages: 14 | 15 | - [Java Client](../clients/java)'s RawKV API is ready for production. 16 | - [Go Client](../clients/go) is still in the proof-of-concept stage and under development. 17 | - [Rust Client](../clients/rust) is still in the proof-of-concept stage and under development. 18 | - [Python Client](../clients/python) is still in the proof-of-concept stage and under development. 19 | - [C++ Client](../clients/cpp) is still in the proof-of-concept stage and under development. 20 | 21 | ## RawKV and TxnKV 22 | 23 | TiKV provides both transactional (TxnKV) API and non-transactional (RawKV) API. 24 | 25 | Learn how to use [RawKV API](../rawkv/introduction/): 26 | 27 | - [Get Put Delete](../rawkv/get-put-delete/) 28 | - [Scan](../rawkv/scan) 29 | - [Time to Live (TTL)](../rawkv/ttl) 30 | - [Compare And Swap (CAS)](../rawkv/cas) 31 | -------------------------------------------------------------------------------- /content/docs/6.1/deploy/configure/rocksdb.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: RocksDB Config 3 | description: Learn how to configure RocksDB engine in TiKV. 4 | menu: 5 | "6.1": 6 | parent: Configure TiKV-v6.1 7 | weight: 8 8 | identifier: RocksDB Config-v6.1 9 | --- 10 | 11 | TiKV uses [RocksDB](https://rocksdb.org/) internally to store Raft logs and key-value pairs. 12 | 13 | TiKV creates two RocksDB instances on each Node: 14 | 15 | * One `rocksdb` instance that stores key-value data. 16 | * One `raftdb` instance that stores Raft logs and has a single column family called `raftdb.defaultcf`. 17 | 18 | The `rocksdb` instance has three column families: 19 | 20 | Column family | Purpose 21 | :-------------|:------- 22 | `rocksdb.defaultcf` | Stores actual KV pairs for TiKV 23 | `rocksdb.lockcf` | Stores transaction lock 24 | `rocksdb.writecf` | Stores transactions' commits and rollback records 25 | 26 | RocksDB can be configured on each column family. Here is an example: 27 | 28 | ```toml 29 | [rocksdb.writecf] 30 | whole-key-filtering = false 31 | ``` 32 | 33 | For more information about the RocksDB configuration parameters, see [RocksDB-related parameters](../tikv-configuration-file/#rocksdb). 34 | -------------------------------------------------------------------------------- /content/docs/6.5/deploy/configure/rocksdb.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: RocksDB Config 3 | description: Learn how to configure RocksDB engine in TiKV. 4 | menu: 5 | "6.5": 6 | parent: Configure TiKV-6.5 7 | weight: 8 8 | identifier: RocksDB Config-6.5 9 | --- 10 | 11 | TiKV uses [RocksDB](https://rocksdb.org/) internally to store Raft logs and key-value pairs. 12 | 13 | TiKV creates two RocksDB instances on each Node: 14 | 15 | * One `rocksdb` instance that stores key-value data. 16 | * One `raftdb` instance that stores Raft logs and has a single column family called `raftdb.defaultcf`. 17 | 18 | The `rocksdb` instance has three column families: 19 | 20 | Column family | Purpose 21 | :-------------|:------- 22 | `rocksdb.defaultcf` | Stores actual KV pairs for TiKV 23 | `rocksdb.lockcf` | Stores transaction lock 24 | `rocksdb.writecf` | Stores transactions' commits and rollback records 25 | 26 | RocksDB can be configured on each column family. Here is an example: 27 | 28 | ```toml 29 | [rocksdb.writecf] 30 | whole-key-filtering = false 31 | ``` 32 | 33 | For more information about the RocksDB configuration parameters, see [RocksDB-related parameters](../tikv-configuration-file/#rocksdb). 34 | -------------------------------------------------------------------------------- /content/docs/7.1/deploy/configure/rocksdb.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: RocksDB Config 3 | description: Learn how to configure RocksDB engine in TiKV. 4 | menu: 5 | "7.1": 6 | parent: Configure TiKV-7.1 7 | weight: 8 8 | identifier: RocksDB Config-7.1 9 | --- 10 | 11 | TiKV uses [RocksDB](https://rocksdb.org/) internally to store Raft logs and key-value pairs. 12 | 13 | TiKV creates two RocksDB instances on each Node: 14 | 15 | * One `rocksdb` instance that stores key-value data. 16 | * One `raftdb` instance that stores Raft logs and has a single column family called `raftdb.defaultcf`. 17 | 18 | The `rocksdb` instance has three column families: 19 | 20 | Column family | Purpose 21 | :-------------|:------- 22 | `rocksdb.defaultcf` | Stores actual KV pairs for TiKV 23 | `rocksdb.lockcf` | Stores transaction lock 24 | `rocksdb.writecf` | Stores transactions' commits and rollback records 25 | 26 | RocksDB can be configured on each column family. Here is an example: 27 | 28 | ```toml 29 | [rocksdb.writecf] 30 | whole-key-filtering = false 31 | ``` 32 | 33 | For more information about the RocksDB configuration parameters, see [RocksDB-related parameters](../tikv-configuration-file/#rocksdb). 34 | -------------------------------------------------------------------------------- /content/docs/dev/deploy/configure/rocksdb.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: RocksDB Config 3 | description: Learn how to configure RocksDB engine in TiKV. 4 | menu: 5 | "dev": 6 | parent: Configure TiKV-dev 7 | weight: 8 8 | identifier: RocksDB Config-dev 9 | --- 10 | 11 | TiKV uses [RocksDB](https://rocksdb.org/) internally to store Raft logs and key-value pairs. 12 | 13 | TiKV creates two RocksDB instances on each Node: 14 | 15 | * One `rocksdb` instance that stores key-value data. 16 | * One `raftdb` instance that stores Raft logs and has a single column family called `raftdb.defaultcf`. 17 | 18 | The `rocksdb` instance has three column families: 19 | 20 | Column family | Purpose 21 | :-------------|:------- 22 | `rocksdb.defaultcf` | Stores actual KV pairs for TiKV 23 | `rocksdb.lockcf` | Stores transaction lock 24 | `rocksdb.writecf` | Stores transactions' commits and rollback records 25 | 26 | RocksDB can be configured on each column family. Here is an example: 27 | 28 | ```toml 29 | [rocksdb.writecf] 30 | whole-key-filtering = false 31 | ``` 32 | 33 | For more information about the RocksDB configuration parameters, see [RocksDB-related parameters](../tikv-configuration-file/#rocksdb). 34 | -------------------------------------------------------------------------------- /content/docs/3.0/tasks/monitor/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Monitor 3 | description: Monitor TiKV 4 | menu: 5 | "3.0": 6 | parent: Tasks 7 | weight: 4 8 | --- 9 | 10 | The TiKV monitoring framework adopts two open-source projects: [Prometheus](https://github.com/prometheus/prometheus) and [Grafana](https://github.com/grafana/grafana). TiKV uses Prometheus to store the monitoring and performance metrics, and uses Grafana to visualize these metrics. 11 | 12 | ## About Prometheus in TiKV 13 | 14 | As a time series database, Prometheus has a multi-dimensional data model and flexible query language. Prometheus consists of multiple components. Currently, TiKV uses the following components: 15 | 16 | - Prometheus Server: to scrape and store time series data 17 | - Client libraries: to customize necessary metrics in the application 18 | - AlertManager: for the alerting mechanism 19 | 20 | {{< figure 21 | src="/img/docs/prometheus.svg" 22 | caption="Prometheus in TiKV" 23 | number="" >}} 24 | 25 | ## About Grafana in TiKV 26 | 27 | [Grafana](https://github.com/grafana/grafana) is an open-source project for analyzing and visualizing metrics. TiKV uses Grafana to display the performance metrics. -------------------------------------------------------------------------------- /content/docs/6.5/develop/develop.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Develop 3 | description: Learn how to use TiKV Clients for different languages 4 | menu: 5 | "6.5": 6 | weight: 3 7 | identifier: Develop-6.5 8 | --- 9 | 10 | Learn how to use TiKV Clients for different languages. 11 | 12 | ## [TiKV Clients](../clients/introduction/) 13 | 14 | TiKV provides the following clients developed in different programming languages: 15 | 16 | - [Java Client](../clients/java) is ready for production. 17 | - [Go Client](../clients/go) is ready for production. 18 | - [Rust Client](../clients/rust) is still in the proof-of-concept stage and under development. 19 | - [Python Client](../clients/python) is still in the proof-of-concept stage and under development. 20 | - [C++ Client](../clients/cpp) is still in the proof-of-concept stage and under development. 21 | 22 | ## RawKV and TxnKV 23 | 24 | TiKV provides both transactional (TxnKV) API and non-transactional (RawKV) API. 25 | 26 | Learn how to use [RawKV API](../rawkv/introduction/): 27 | 28 | - [Get Put Delete](../rawkv/get-put-delete/) 29 | - [Scan](../rawkv/scan) 30 | - [Time to Live (TTL)](../rawkv/ttl) 31 | - [Compare And Swap (CAS)](../rawkv/cas) 32 | - [Checksum](../rawkv/checksum) 33 | -------------------------------------------------------------------------------- /content/docs/7.1/develop/develop.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Develop 3 | description: Learn how to use TiKV Clients for different languages 4 | menu: 5 | "7.1": 6 | weight: 3 7 | identifier: Develop-7.1 8 | --- 9 | 10 | Learn how to use TiKV Clients for different languages. 11 | 12 | ## [TiKV Clients](../clients/introduction/) 13 | 14 | TiKV provides the following clients developed in different programming languages: 15 | 16 | - [Java Client](../clients/java) is ready for production. 17 | - [Go Client](../clients/go) is ready for production. 18 | - [Rust Client](../clients/rust) is still in the proof-of-concept stage and under development. 19 | - [Python Client](../clients/python) is still in the proof-of-concept stage and under development. 20 | - [C++ Client](../clients/cpp) is still in the proof-of-concept stage and under development. 21 | 22 | ## RawKV and TxnKV 23 | 24 | TiKV provides both transactional (TxnKV) API and non-transactional (RawKV) API. 25 | 26 | Learn how to use [RawKV API](../rawkv/introduction/): 27 | 28 | - [Get Put Delete](../rawkv/get-put-delete/) 29 | - [Scan](../rawkv/scan) 30 | - [Time to Live (TTL)](../rawkv/ttl) 31 | - [Compare And Swap (CAS)](../rawkv/cas) 32 | - [Checksum](../rawkv/checksum) 33 | -------------------------------------------------------------------------------- /content/docs/dev/develop/develop.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Develop 3 | description: Learn how to use TiKV Clients for different languages 4 | menu: 5 | "dev": 6 | weight: 3 7 | identifier: Develop-dev 8 | --- 9 | 10 | Learn how to use TiKV Clients for different languages. 11 | 12 | ## [TiKV Clients](../clients/introduction/) 13 | 14 | TiKV provides the following clients developed in different programming languages: 15 | 16 | - [Java Client](../clients/java) is ready for production. 17 | - [Go Client](../clients/go) is ready for production. 18 | - [Rust Client](../clients/rust) is still in the proof-of-concept stage and under development. 19 | - [Python Client](../clients/python) is still in the proof-of-concept stage and under development. 20 | - [C++ Client](../clients/cpp) is still in the proof-of-concept stage and under development. 21 | 22 | ## RawKV and TxnKV 23 | 24 | TiKV provides both transactional (TxnKV) API and non-transactional (RawKV) API. 25 | 26 | Learn how to use [RawKV API](../rawkv/introduction/): 27 | 28 | - [Get Put Delete](../rawkv/get-put-delete/) 29 | - [Scan](../rawkv/scan) 30 | - [Time to Live (TTL)](../rawkv/ttl) 31 | - [Compare And Swap (CAS)](../rawkv/cas) 32 | - [Checksum](../rawkv/checksum) 33 | -------------------------------------------------------------------------------- /content/docs/4.0/tasks/monitor/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Monitor 3 | description: Monitor TiKV 4 | menu: 5 | "4.0": 6 | parent: Tasks 7 | weight: 4 8 | --- 9 | 10 | The TiKV monitoring framework adopts two open-source projects: [Prometheus](https://github.com/prometheus/prometheus) and [Grafana](https://github.com/grafana/grafana). TiKV uses Prometheus to store the monitoring and performance metrics, and uses Grafana to visualize these metrics. 11 | 12 | ## About Prometheus in TiKV 13 | 14 | As a time series database, Prometheus has a multi-dimensional data model and flexible query language. Prometheus consists of multiple components. Currently, TiKV uses the following components: 15 | 16 | - Prometheus Server: to scrape and store time series data 17 | - Client libraries: to customize necessary metrics in the application 18 | - Pushgateway: to receive the data from Client Push for the Prometheus main server 19 | - AlertManager: for the alerting mechanism 20 | 21 | {{< figure 22 | src="/img/docs/prometheus-in-tikv.png" 23 | caption="Prometheus in TiKV" 24 | number="" >}} 25 | 26 | ## About Grafana in TiKV 27 | 28 | [Grafana](https://github.com/grafana/grafana) is an open-source project for analyzing and visualizing metrics. TiKV uses Grafana to display the performance metrics. -------------------------------------------------------------------------------- /content/docs/5.1/deploy/monitor/framework.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Monitoring Framework 3 | description: Use Prometheus and Grafana to build the TiKV monitoring framework. 4 | menu: 5 | "5.1": 6 | parent: Monitor and Alert 7 | weight: 1 8 | --- 9 | 10 | The TiKV monitoring framework adopts two open-source projects: [Prometheus](https://github.com/prometheus/prometheus) and [Grafana](https://github.com/grafana/grafana). TiKV uses Prometheus to store the monitoring and performance metrics, and uses Grafana to visualize these metrics. 11 | 12 | ## About Prometheus in TiKV 13 | 14 | Prometheus is a time-series database and has a multi-dimensional data model and flexible query language. Prometheus consists of multiple components. Currently, TiKV uses the following components: 15 | 16 | - Prometheus Server: to scrape and store time series data 17 | - Client libraries: to customize necessary metrics in the application 18 | - AlertManager: for the alerting mechanism 19 | 20 | {{< figure 21 | src="/img/docs/prometheus-in-tikv2.png" 22 | caption="Prometheus in TiKV" 23 | number="" >}} 24 | 25 | ## About Grafana in TiKV 26 | 27 | [Grafana](https://github.com/grafana/grafana) is an open-source project for analyzing and visualizing metrics. TiKV uses Grafana to display the performance metrics. 28 | -------------------------------------------------------------------------------- /content/docs/3.0/tasks/configure/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Configure 3 | description: Configure a wide range of TiKV facets, including RocksDB, gRPC, the Placement Driver, and more 4 | menu: 5 | "3.0": 6 | parent: Tasks 7 | weight: 3 8 | --- 9 | 10 | TiKV features a large number of configuration options you can use to tweak TiKV's behavior. When getting started with TiKV, it's usually safe to start with the defaults, configuring only the `--pd` (`pd.endpoints`) configuration. 11 | 12 | There are several guides that you can use to inform your configuration: 13 | 14 | * [**Security**](../security): Use TLS security and review security procedures. 15 | * [**Topology**](../topology): Use location awareness to improve resiliency and performance. 16 | * [**Namespace**](../namespace): Use namespacing to configure resource isolation. 17 | * [**Limit**](../limit): Tweak rate limiting. 18 | * [**Region Merge**](../region-merge): Tweak region merging. 19 | * [**RocksDB**](../rocksdb): Tweak RocksDB configuration options. 20 | * [**Titan**](../titan): Enable titan to improve performance with large values. 21 | 22 | You can find an exhaustive list of all options, as well as what they do, in the documented [**full configuration template**](https://github.com/tikv/tikv/blob/release-3.0/etc/config-template.toml). 23 | -------------------------------------------------------------------------------- /content/community/sig-transaction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Transaction SIG 3 | description: Information about the transaction special interest group 4 | --- 5 | 6 | The transactions special interest group (SIG-transaction) are a group of people interested in transactions in distributed databases. We have a focus on transactions in TiKV and TiDB, but discuss academic work and other implementations too. 7 | 8 | The SIG is in the process of starting up. In the near future we hope to host: 9 | 10 | * talks on distributed transactions, 11 | * a reading group for academic papers, 12 | * discussion of transaction research and implementations on Slack, 13 | * help understanding and configuring transactions in TiKV and TiDB, 14 | * support for contributors to TiKV and related projects. 15 | 16 | See our [repository](https://github.com/tikv/sig-transaction) for more information. 17 | 18 | ## How to get involved 19 | 20 | You can join us in #sig-transaction in the [TiKV community Slack](https://slack.tidb.io/invite?team=tikv-wg&channel=sig-transaction&ref=community-sig); come say hi! We use English and Chinese. 21 | 22 | You can read or join our announcement [mailing list](https://groups.google.com/d/forum/tikv-sig-transaction), so you can stay up to date with what we're up to. 23 | 24 | We will have formal membership of the group ready later in the year. 25 | -------------------------------------------------------------------------------- /content/docs/4.0/tasks/configure/coprocessor.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Coprocessor Config 3 | description: Learn how to configure Coprocessor in TiKV. 4 | menu: 5 | "4.0": 6 | parent: Configure 7 | weight: 12 8 | --- 9 | 10 | This document describes the configuration parameters related to Coprocessor. 11 | 12 | ### `split-region-on-table` 13 | 14 | + Determines whether to split Region by table. It is recommended to use the feature only in the TiDB mode. 15 | + Default value: `true` 16 | 17 | ### `batch-split-limit` 18 | 19 | + The threshold of Region split in batches. Increasing this value speeds up Region split. 20 | + Default value: `10` 21 | + Minimum value: `1` 22 | 23 | ### `region-max-size` 24 | 25 | + The maximum size of a Region. When the value is exceeded, the Region splits into many. 26 | + Default value: `144MB` 27 | + Unit: KB|MB|GB 28 | 29 | ### `region-split-size` 30 | 31 | + The size of the newly split Region. This value is an estimate. 32 | + Default value: `96MB` 33 | + Unit: KB|MB|GB 34 | 35 | ### `region-max-keys` 36 | 37 | + The maximum allowable number of keys in a Region. When this value is exceeded, the Region splits into many. 38 | + Default value: `1440000` 39 | 40 | ### `region-split-keys` 41 | 42 | + The number of keys in the newly split Region. This value is an estimate. 43 | + Default value: `960000` 44 | -------------------------------------------------------------------------------- /content/docs/6.1/deploy/monitor/framework.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Monitoring Framework 3 | description: Use Prometheus and Grafana to build the TiKV monitoring framework. 4 | menu: 5 | "6.1": 6 | parent: Monitor and Alert-v6.1 7 | weight: 1 8 | identifier: Monitoring Framework-v6.1 9 | --- 10 | 11 | The TiKV monitoring framework adopts two open-source projects: [Prometheus](https://github.com/prometheus/prometheus) and [Grafana](https://github.com/grafana/grafana). TiKV uses Prometheus to store the monitoring and performance metrics, and uses Grafana to visualize these metrics. 12 | 13 | ## About Prometheus in TiKV 14 | 15 | Prometheus is a time-series database and has a multi-dimensional data model and flexible query language. Prometheus consists of multiple components. Currently, TiKV uses the following components: 16 | 17 | - Prometheus Server: to scrape and store time series data 18 | - Client libraries: to customize necessary metrics in the application 19 | - AlertManager: for the alerting mechanism 20 | 21 | {{< figure 22 | src="/img/docs/prometheus-in-tikv2.png" 23 | caption="Prometheus in TiKV" 24 | number="" >}} 25 | 26 | ## About Grafana in TiKV 27 | 28 | [Grafana](https://github.com/grafana/grafana) is an open-source project for analyzing and visualizing metrics. TiKV uses Grafana to display the performance metrics. 29 | -------------------------------------------------------------------------------- /content/docs/6.5/deploy/monitor/framework.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Monitoring Framework 3 | description: Use Prometheus and Grafana to build the TiKV monitoring framework. 4 | menu: 5 | "6.5": 6 | parent: Monitor and Alert-6.5 7 | weight: 1 8 | identifier: Monitoring Framework-6.5 9 | --- 10 | 11 | The TiKV monitoring framework adopts two open-source projects: [Prometheus](https://github.com/prometheus/prometheus) and [Grafana](https://github.com/grafana/grafana). TiKV uses Prometheus to store the monitoring and performance metrics, and uses Grafana to visualize these metrics. 12 | 13 | ## About Prometheus in TiKV 14 | 15 | Prometheus is a time-series database and has a multi-dimensional data model and flexible query language. Prometheus consists of multiple components. Currently, TiKV uses the following components: 16 | 17 | - Prometheus Server: to scrape and store time series data 18 | - Client libraries: to customize necessary metrics in the application 19 | - AlertManager: for the alerting mechanism 20 | 21 | {{< figure 22 | src="/img/docs/prometheus-in-tikv2.png" 23 | caption="Prometheus in TiKV" 24 | number="" >}} 25 | 26 | ## About Grafana in TiKV 27 | 28 | [Grafana](https://github.com/grafana/grafana) is an open-source project for analyzing and visualizing metrics. TiKV uses Grafana to display the performance metrics. 29 | -------------------------------------------------------------------------------- /content/docs/7.1/deploy/monitor/framework.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Monitoring Framework 3 | description: Use Prometheus and Grafana to build the TiKV monitoring framework. 4 | menu: 5 | "7.1": 6 | parent: Monitor and Alert-7.1 7 | weight: 1 8 | identifier: Monitoring Framework-7.1 9 | --- 10 | 11 | The TiKV monitoring framework adopts two open-source projects: [Prometheus](https://github.com/prometheus/prometheus) and [Grafana](https://github.com/grafana/grafana). TiKV uses Prometheus to store the monitoring and performance metrics, and uses Grafana to visualize these metrics. 12 | 13 | ## About Prometheus in TiKV 14 | 15 | Prometheus is a time-series database and has a multi-dimensional data model and flexible query language. Prometheus consists of multiple components. Currently, TiKV uses the following components: 16 | 17 | - Prometheus Server: to scrape and store time series data 18 | - Client libraries: to customize necessary metrics in the application 19 | - AlertManager: for the alerting mechanism 20 | 21 | {{< figure 22 | src="/img/docs/prometheus-in-tikv2.png" 23 | caption="Prometheus in TiKV" 24 | number="" >}} 25 | 26 | ## About Grafana in TiKV 27 | 28 | [Grafana](https://github.com/grafana/grafana) is an open-source project for analyzing and visualizing metrics. TiKV uses Grafana to display the performance metrics. 29 | -------------------------------------------------------------------------------- /content/docs/dev/deploy/monitor/framework.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Monitoring Framework 3 | description: Use Prometheus and Grafana to build the TiKV monitoring framework. 4 | menu: 5 | "dev": 6 | parent: Monitor and Alert-dev 7 | weight: 1 8 | identifier: Monitoring Framework-dev 9 | --- 10 | 11 | The TiKV monitoring framework adopts two open-source projects: [Prometheus](https://github.com/prometheus/prometheus) and [Grafana](https://github.com/grafana/grafana). TiKV uses Prometheus to store the monitoring and performance metrics, and uses Grafana to visualize these metrics. 12 | 13 | ## About Prometheus in TiKV 14 | 15 | Prometheus is a time-series database and has a multi-dimensional data model and flexible query language. Prometheus consists of multiple components. Currently, TiKV uses the following components: 16 | 17 | - Prometheus Server: to scrape and store time series data 18 | - Client libraries: to customize necessary metrics in the application 19 | - AlertManager: for the alerting mechanism 20 | 21 | {{< figure 22 | src="/img/docs/prometheus-in-tikv2.png" 23 | caption="Prometheus in TiKV" 24 | number="" >}} 25 | 26 | ## About Grafana in TiKV 27 | 28 | [Grafana](https://github.com/grafana/grafana) is an open-source project for analyzing and visualizing metrics. TiKV uses Grafana to display the performance metrics. 29 | -------------------------------------------------------------------------------- /content/docs/4.0/tasks/configure/storage.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Storage Config 3 | description: Learn how to configure storage in TiKV. 4 | menu: 5 | "4.0": 6 | parent: Configure 7 | weight: 10 8 | --- 9 | 10 | This document describes the configuration parameters related to storage. 11 | 12 | ### `scheduler-concurrency` 13 | 14 | + A built-in memory lock mechanism to prevent simultaneous operations on a key. Each key has a hash in a different slot. 15 | + Default value: `2048000` 16 | + Minimum value: `1` 17 | 18 | ### `scheduler-worker-pool-size` 19 | 20 | + The number of `scheduler` threads, mainly used for checking transaction consistency before data writing 21 | + Default value: `4` 22 | + Minimum value: `1` 23 | 24 | ### `scheduler-pending-write-threshold` 25 | 26 | + The maximum size of the write queue. A `Server Is Busy` error is returned for a new write to TiKV when this value is exceeded. 27 | + Default value: `100MB` 28 | + Unit: MB|GB 29 | 30 | ### `reserve-space` 31 | 32 | + The size of the temporary file that preoccupies the extra space when TiKV is started. The name of temporary file is `space_placeholder_file`, located in the `storage.data-dir` directory. When TiKV runs out of disk space and cannot be started normally, you can delete this file as an emergency intervention and set `reserve-space` to `0MB`. 33 | + Default value: `2GB` 34 | + Unite: MB|GB 35 | -------------------------------------------------------------------------------- /static/img/homepage/tikv-logo-white.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /static/img/logos/horizontal/white/tikv-horizontal-white.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # The TiKV website 2 | 3 | This repo houses the assets used to build the [TiKV](https://github.com/tikv/tikv) website available at https://tikv.org. 4 | 5 | ## Publishing 6 | 7 | The site is published automatically by [Netlify](https://netlify.com) whenever changes are pushed to the `master` branch. You do not need to manually publish or manage the site deployment. 8 | 9 | ## Running the site locally 10 | 11 | To run the site locally, you'll need to install [Yarn](https://yarnpkg.com) and [Hugo](https://gohugo.io) (in particular the [extended](https://gohugo.io/getting-started/installing/) version). 12 | 13 | You can then host the development server for the site with: 14 | 15 | ```bash 16 | make serve 17 | ``` 18 | 19 | Next, browse to [http://localhost:1313/](http://localhost:1313/). 20 | 21 | Alternatively you can use the provided `Dockerfile` via: 22 | 23 | ```bash 24 | make docker 25 | ``` 26 | 27 | > If you're using Docker for Mac or Windows, you may need to browse to the correct address, or set up port forwarding `1313`. On Linux or [WSL2 with Docker](https://hoverbear.org/blog/getting-the-most-out-of-wsl/#get-systemd-functional) you can visit [http://localhost:1313/](http://localhost:1313/). 28 | 29 | ## Adding blog posts 30 | 31 | To add a new blog post, add a Markdown file to the `content/blog` folder. There's currently a `first-post.md` file in that directory that can serve as a template. 32 | -------------------------------------------------------------------------------- /layouts/partials/blog/hero.html: -------------------------------------------------------------------------------- 1 | {{ $author := .Params.author }} 2 | {{ $date := dateFormat "January 2, 2006" .Date }} 3 | {{ $twitterUrl := printf "https://twitter.com/intent/tweet?text=%s %s" (printf "Check out this post from the TiKV blog: \"%s\"" .Title) .Permalink }} 4 |
5 |
6 |
7 |

8 | {{ .Title }} 9 |

10 | 11 | {{ if eq .RelPermalink "/blog/" }} 12 |   Subscribe via RSS 13 | {{ end }} 14 | 15 | {{ with $author }} 16 |

17 | {{ . | markdownify }} 18 |

19 | {{ end }} 20 | 21 | {{ if ne .RelPermalink "/blog/" }} 22 |

23 | {{ $date }} 24 |

25 | 26 |
27 | 28 |
29 | 34 |
35 | {{ end }} 36 |
37 |
38 |
39 | -------------------------------------------------------------------------------- /static/img/homepage/easy-to-use.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /layouts/partials/docs/hero.html: -------------------------------------------------------------------------------- 1 | {{ $docs := where site.Pages "Section" "docs" }} 2 | {{ $description := .Params.description }} 3 | {{ $currentUrl := .RelPermalink }} 4 | {{ $isNew := .Params.new }} 5 | {{ $docsSections := where site.Sections "Section" "docs" }} 6 | {{ $currentSection := .CurrentSection.Name }} 7 | {{ partial "navbar.html" . }} 8 | 9 |
10 |
11 |
12 |

13 | {{ .Title }} 14 | 15 | {{ if $isNew }} 16 | 17 | New 18 | 19 | {{ end }} 20 |

21 | 22 | {{ with $description }} 23 |

24 | {{ . }} 25 |

26 | {{ end }} 27 |
28 |
29 | 30 |
31 | 45 |
46 |
47 | -------------------------------------------------------------------------------- /static/img/homepage/high-scalability.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /content/docs/5.1/concepts/whats-next.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: What's Next 3 | description: 4 | menu: 5 | "5.1": 6 | parent: Get Started 7 | weight: 3 8 | --- 9 | 10 | Depending on your role, the following resources are recommended to learn more about TiKV: 11 | 12 | - As a TiKV cluster administrator, you can refer to the following administration instructions: 13 | 14 | - Install a TiKV cluster: [Install TiKV](../../deploy/install/install/) 15 | - Config a TiKV cluster: [Configure TiKV](../../deploy/configure/introduction/) 16 | - Benchmark of a TiKV cluster: [Benchmark and Performance](../../deploy/benchmark/benchmark/) 17 | - Monitor a TiKV cluster: [Monitor and Alert](../../deploy/monitor/monitor/) 18 | - Maintain and operate a TiKV cluster: [Operate TiKV Cluster](../../deploy/operate/operate/) 19 | - Administrate TiKV Cluster with CLI Tools: [CLI](../../reference/cli/introduction/) 20 | 21 | - As an application developer, you can refer to the following development instructions: 22 | 23 | - Interact with a TiKV cluster using TiKV clients: [TiKV clients](../../develop/clients/introduction/) 24 | - Interact with TiKV using RawKV API: [RawKV](../../develop/rawkv/introduction/) 25 | - Learn the architecture of TiKV: [Architecture](../../reference/architecture/introduction/) 26 | 27 | - If you want to become a TiKV contributor, you can refer to the following contribution instructions: 28 | 29 | - How to be a TiKV Contributor: [Contribute](/community/contribute/) 30 | - The internal of TiKV: [Deep Dive](/deep-dive/introduction/) 31 | -------------------------------------------------------------------------------- /content/docs/6.1/concepts/whats-next.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: What's Next 3 | description: 4 | menu: 5 | "6.1": 6 | parent: Get Started-v6.1 7 | weight: 3 8 | identifier: What's Next-v6.1 9 | --- 10 | 11 | Depending on your role, the following resources are recommended to learn more about TiKV: 12 | 13 | - As a TiKV cluster administrator, you can refer to the following administration instructions: 14 | 15 | - Install a TiKV cluster: [Install TiKV](../../deploy/install/install/) 16 | - Config a TiKV cluster: [Configure TiKV](../../deploy/configure/introduction/) 17 | - Benchmark of a TiKV cluster: [Benchmark and Performance](../../deploy/benchmark/benchmark/) 18 | - Monitor a TiKV cluster: [Monitor and Alert](../../deploy/monitor/monitor/) 19 | - Maintain and operate a TiKV cluster: [Operate TiKV Cluster](../../deploy/operate/operate/) 20 | - Administrate TiKV Cluster with CLI Tools: [CLI](../../reference/cli/introduction/) 21 | 22 | - As an application developer, you can refer to the following development instructions: 23 | 24 | - Interact with a TiKV cluster using TiKV clients: [TiKV clients](../../develop/clients/introduction/) 25 | - Interact with TiKV using RawKV API: [RawKV](../../develop/rawkv/introduction/) 26 | - Learn the architecture of TiKV: [Architecture](../../reference/architecture/introduction/) 27 | 28 | - If you want to become a TiKV contributor, you can refer to the following contribution instructions: 29 | 30 | - How to be a TiKV Contributor: [Contribute](/community/contribute/) 31 | - The internal of TiKV: [Deep Dive](/deep-dive/introduction/) 32 | -------------------------------------------------------------------------------- /content/docs/6.5/concepts/whats-next.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: What's Next 3 | description: 4 | menu: 5 | "6.5": 6 | parent: Get Started-6.5 7 | weight: 3 8 | identifier: What's Next-6.5 9 | --- 10 | 11 | Depending on your role, the following resources are recommended to learn more about TiKV: 12 | 13 | - As a TiKV cluster administrator, you can refer to the following administration instructions: 14 | 15 | - Install a TiKV cluster: [Install TiKV](../../deploy/install/install/) 16 | - Config a TiKV cluster: [Configure TiKV](../../deploy/configure/introduction/) 17 | - Benchmark of a TiKV cluster: [Benchmark and Performance](../../deploy/benchmark/benchmark/) 18 | - Monitor a TiKV cluster: [Monitor and Alert](../../deploy/monitor/monitor/) 19 | - Maintain and operate a TiKV cluster: [Operate TiKV Cluster](../../deploy/operate/operate/) 20 | - Administrate TiKV Cluster with CLI Tools: [CLI](../../reference/cli/introduction/) 21 | 22 | - As an application developer, you can refer to the following development instructions: 23 | 24 | - Interact with a TiKV cluster using TiKV clients: [TiKV clients](../../develop/clients/introduction/) 25 | - Interact with TiKV using RawKV API: [RawKV](../../develop/rawkv/introduction/) 26 | - Learn the architecture of TiKV: [Architecture](../../reference/architecture/introduction/) 27 | 28 | - If you want to become a TiKV contributor, you can refer to the following contribution instructions: 29 | 30 | - How to be a TiKV Contributor: [Contribute](/community/contribute/) 31 | - The internal of TiKV: [Deep Dive](/deep-dive/introduction/) 32 | -------------------------------------------------------------------------------- /content/docs/7.1/concepts/whats-next.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: What's Next 3 | description: 4 | menu: 5 | "7.1": 6 | parent: Get Started-7.1 7 | weight: 3 8 | identifier: What's Next-7.1 9 | --- 10 | 11 | Depending on your role, the following resources are recommended to learn more about TiKV: 12 | 13 | - As a TiKV cluster administrator, you can refer to the following administration instructions: 14 | 15 | - Install a TiKV cluster: [Install TiKV](../../deploy/install/install/) 16 | - Config a TiKV cluster: [Configure TiKV](../../deploy/configure/introduction/) 17 | - Benchmark of a TiKV cluster: [Benchmark and Performance](../../deploy/benchmark/benchmark/) 18 | - Monitor a TiKV cluster: [Monitor and Alert](../../deploy/monitor/monitor/) 19 | - Maintain and operate a TiKV cluster: [Operate TiKV Cluster](../../deploy/operate/operate/) 20 | - Administrate TiKV Cluster with CLI Tools: [CLI](../../reference/cli/introduction/) 21 | 22 | - As an application developer, you can refer to the following development instructions: 23 | 24 | - Interact with a TiKV cluster using TiKV clients: [TiKV clients](../../develop/clients/introduction/) 25 | - Interact with TiKV using RawKV API: [RawKV](../../develop/rawkv/introduction/) 26 | - Learn the architecture of TiKV: [Architecture](../../reference/architecture/introduction/) 27 | 28 | - If you want to become a TiKV contributor, you can refer to the following contribution instructions: 29 | 30 | - How to be a TiKV Contributor: [Contribute](/community/contribute/) 31 | - The internal of TiKV: [Deep Dive](/deep-dive/introduction/) 32 | -------------------------------------------------------------------------------- /content/docs/dev/concepts/whats-next.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: What's Next 3 | description: 4 | menu: 5 | "dev": 6 | parent: Get Started-dev 7 | weight: 3 8 | identifier: What's Next-dev 9 | --- 10 | 11 | Depending on your role, the following resources are recommended to learn more about TiKV: 12 | 13 | - As a TiKV cluster administrator, you can refer to the following administration instructions: 14 | 15 | - Install a TiKV cluster: [Install TiKV](../../deploy/install/install/) 16 | - Config a TiKV cluster: [Configure TiKV](../../deploy/configure/introduction/) 17 | - Benchmark of a TiKV cluster: [Benchmark and Performance](../../deploy/benchmark/benchmark/) 18 | - Monitor a TiKV cluster: [Monitor and Alert](../../deploy/monitor/monitor/) 19 | - Maintain and operate a TiKV cluster: [Operate TiKV Cluster](../../deploy/operate/operate/) 20 | - Administrate TiKV Cluster with CLI Tools: [CLI](../../reference/cli/introduction/) 21 | 22 | - As an application developer, you can refer to the following development instructions: 23 | 24 | - Interact with a TiKV cluster using TiKV clients: [TiKV clients](../../develop/clients/introduction/) 25 | - Interact with TiKV using RawKV API: [RawKV](../../develop/rawkv/introduction/) 26 | - Learn the architecture of TiKV: [Architecture](../../reference/architecture/introduction/) 27 | 28 | - If you want to become a TiKV contributor, you can refer to the following contribution instructions: 29 | 30 | - How to be a TiKV Contributor: [Contribute](/community/contribute/) 31 | - The internal of TiKV: [Deep Dive](/deep-dive/introduction/) 32 | -------------------------------------------------------------------------------- /content/deep-dive/distributed-transaction/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Distributed transaction 3 | aliases: ['/docs/deep-dive/distributed-transaction/introduction'] 4 | menu: 5 | nav: 6 | parent: Deep Dive 7 | weight: 4 8 | --- 9 | 10 | As TiKV is a distributed transactional key-value database, transaction is a core feature of TiKV. In this chapter we will talk about general implementations of distributed transaction and some implementation details in TiKV. 11 | 12 | A database transaction, by definition, must be atomic, consistent, isolated and durable. Database practitioners often refer to these properties of database transactions using the acronym ACID. 13 | 14 | Transactions provide an "all-or-nothing" proposition: each work-unit performed in a database must either complete in its entirety or have no effect whatsoever. Furthermore, the system must isolate each transaction from other transactions, results must conform to existing constraints in the database, and transactions that complete successfully must get written to durable storage. 15 | 16 | A distributed transaction is a database transaction in which two or more network hosts are involved. Usually, hosts provide transactional resources, while the transaction manager is responsible for creating and managing a global transaction that encompasses all operations against such resources. Distributed transactions, as any other transactions, must have all four ACID properties. 17 | 18 | A common algorithm for ensuring correct completion of a distributed transaction is the two-phase commit (2PC). 19 | 20 | TiKV adopts Google's Percolator transaction model, a variant of 2PC. 21 | -------------------------------------------------------------------------------- /content/docs/4.0/tasks/configure/grpc.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: gRPC Config 3 | description: Learn how to configure gRPC in TiKV. 4 | menu: 5 | "4.0": 6 | parent: Configure 7 | weight: 11 8 | --- 9 | 10 | This document describes the configuration parameters related to gRPC. 11 | 12 | ### `grpc-compression-type` 13 | 14 | + The compression algorithm for gRPC messages 15 | + Optional values: `"none"`, `"deflate"`, `"gzip"` 16 | + Default value: `"none"` 17 | 18 | ### `grpc-concurrency` 19 | 20 | + The number of gRPC worker threads 21 | + Default value: `4` 22 | + Minimum value: `1` 23 | 24 | ### `grpc-concurrent-stream` 25 | 26 | + The maximum number of concurrent requests allowed in a gRPC stream 27 | + Default value: `1024` 28 | + Minimum value: `1` 29 | 30 | ### `grpc-memory-pool-quota` 31 | 32 | + Limit the memory size that can be used by gRPC 33 | + Default: `"32G"` 34 | + Limit the memory in case OOM is observed. Note that limit the usage can lead to potential stall 35 | 36 | ### `server.grpc-raft-conn-num` 37 | 38 | + The maximum number of links among TiKV nodes for Raft communication 39 | + Default: `10` 40 | + Minimum value: `1` 41 | 42 | ### `server.grpc-stream-initial-window-size` 43 | 44 | + The window size of the gRPC stream 45 | + Default: `"2MB"` 46 | + Unit: KB|MB|GB 47 | + Minimum value: `"1KB"` 48 | 49 | ### `server.grpc-keepalive-time` 50 | 51 | + The time interval at which that gRPC sends `keepalive` Ping messages 52 | + Default: `"10s"` 53 | + Minimum value: `"1s"` 54 | 55 | ### `server.grpc-keepalive-timeout` 56 | 57 | + Disables the timeout for gRPC streams 58 | + Default: `"3s"` 59 | + Minimum value: `"1s"` 60 | -------------------------------------------------------------------------------- /content/blog/tikv-community-connections.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: TiKV Community Connections 3 | date: 2019-04-03 4 | author: Ana Hobden, TiKV Ecosystem Lead 5 | tags: ['Community'] 6 | --- 7 | 8 | A few months ago at [TiDB DevCon](https://pingcap.com/community-cn/devcon2019/) we talked about how we'd be opening new TiKV community forums & a community chat. We're very happy to announce we're releasing [forum.tikv.org](http://forum.tikv.org/) for forums, and [tikv-wg slack](https://join.slack.com/t/tikv-wg/shared_invite/enQtNTUyODE4ODU2MzI0LTgzZDQ3NzZlNDkzMGIyYjU1MTA0NzIwMjFjODFiZjA0YjFmYmQyOTZiNzNkNzg1N2U1MDdlZTIxNTU5NWNhNjk) for chat. 9 | 10 | 11 | 12 | These spaces are designed so our community can discuss and share together. During our planning we realized that a synchronous space such as Slack or Discord offers a good place for ephemeral *conversations*, *discussions*, and *troubleshooting*, while spaces such as forums or Discourse offer a semi-permanent spaces for sharing *articles*, *stories*, and *guides*. 13 | 14 | This space isn't just for TiKV! You'll also find topics for some of TiKVs dependencies as well: [`raft-rs`](https://github.com/pingcap/raft-rs), [`gRPC-rs`](https://github.com/pingcap/grpc-rs/), [`rust-prometheus`](https://github.com/pingcap/rust-prometheus/), and [`fail-rs`](https://github.com/pingcap/fail-rs). 15 | 16 | As with all TiKV project spaces, please follow the [code of conduct](https://github.com/tikv/tikv/blob/master/CODE_OF_CONDUCT.md) with us so we can foster a vibrant, accepting, worldwide community. 17 | 18 | The spaces are still quite young and in continuous evolution, but we'd love to have you join us and share. 19 | -------------------------------------------------------------------------------- /content/deep-dive/key-value-engine/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Key-value engine 3 | aliases: ['/docs/deep-dive/key-value-engine/introduction'] 4 | menu: 5 | nav: 6 | parent: Deep Dive 7 | weight: 3 8 | --- 9 | 10 | A key-value engine serves as the bottommost layer in a key-value 11 | database, unless you are going to build your own file system or 12 | operating system. A key-value engine is crucial for a database because 13 | it manages all the persistent data directly. 14 | 15 | Most key-value engines provide some common interfaces like `Get`, 16 | `Put` and `Delete`. Some engines also allow you to iterate the 17 | key-values in order efficiently, and most will provide special 18 | features for added efficiency. 19 | 20 | Choosing a key value engine is the first step to build a 21 | database. Here are some important things we need to consider: 22 | 23 | - _The data structure_. Different data structures are optimized for 24 | different workloads. Some are good for reads and some are good for 25 | writes, etc. 26 | - _Maturity_. We don't need a storage engine to be fancy but we want it 27 | to be reliable. Buggy engines ruin everything you build on top of 28 | them. We recommend using a battle-tested storage engine which has 29 | been adopted by a lot of users. 30 | - _Performance_. The performance of the storage engine limits the 31 | overall performance of the whole database. So make sure the storage 32 | engine meets your expectation and has the potential to improve along 33 | with the database. 34 | 35 | In this chapter, we will do a comparison between two well-known data 36 | structures and guide you through the storage engine used in TiKV. 37 | -------------------------------------------------------------------------------- /content/deep-dive/consensus-algorithm/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Consensus algorithm 3 | aliases: ['/docs/deep-dive/consensus-algorithm/introduction'] 4 | menu: 5 | nav: 6 | parent: Deep Dive 7 | weight: 2 8 | --- 9 | 10 | When building a distributed system, one principal goal is to build in fault-tolerance. That is, if one particular node in the network goes down, or if there is a network partition, the system should continue to operate in a consistent way, i.e., nodes in the system should have a consensus on the state (or simply "values") of the system. The consensus should be considered final once it is reached, even if some nodes were in faulty states at the time of decision. 11 | 12 | Distributed consensus algorithms often take the form of a replicated state machine and log. Each state machine accepts inputs from its log, and represents the value(s) to be replicated, for example, a change to a hash table. They allow a collection of machines to work as a coherent group that can survive the failures of some of its members. 13 | 14 | Two well known distributed consensus algorithms are [Paxos](https://lamport.azurewebsites.net/pubs/paxos-simple.pdf) and [Raft](https://raft.github.io/raft.pdf). Paxos is used in systems like [Chubby](http://research.google.com/archive/chubby.html) by Google, and Raft is used in systems like [TiKV](https://github.com/tikv/tikv) or [etcd](https://github.com/coreos/etcd/tree/master/raft). Raft is generally seen as more understandable and simpler to implement than Paxos. 15 | 16 | In TiKV we harness Raft for distributed consensus. We found it much easier to understand both the algorithm, and how it will behave in even truly perverse scenarios. 17 | -------------------------------------------------------------------------------- /content/docs/4.0/releases/4.0.0-rc.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: 4.0.0 RC 3 | description: TiKV 4.0.0 RC Release Notes 4 | menu: 5 | "4.0": 6 | parent: Releases 7 | weight: 2 8 | --- 9 | 10 | Release date: April 8, 2020 11 | 12 | TiKV version: 4.0.0-rc 13 | 14 | ## Compatibility Changes 15 | 16 | + TiKV 17 | 18 | - Support the `pipelined` feature in pessimistic transactions, which improves the TPC-C performance by 20%. The risk is that the transaction commit might fail because of lock failure during the execution [#6984](https://github.com/tikv/tikv/pull/6984) 19 | - Enable the `unify-read-pool` configuration item in new clusters by default and use the previous setting of this item in old clusters [#7059](https://github.com/tikv/tikv/pull/7059) 20 | 21 | ## New Features 22 | 23 | + TiKV 24 | 25 | - Support the `pipelined` feature in pessimistic transactions, which improves the TPC-C performance by 20%. The risk is that the transaction commit might fail because of lock failure during the execution [#6984](https://github.com/tikv/tikv/pull/6984) 26 | - Support TLS in the HTTP port [#5393](https://github.com/tikv/tikv/pull/5393) 27 | - Enable the `unify-read-pool` configuration item in new clusters by default and use the previous setting of this item in old clusters [#7059](https://github.com/tikv/tikv/pull/7059) 28 | 29 | + PD 30 | 31 | - Support getting the default PD configuration information through the HTTP API [#2258](https://github.com/pingcap/pd/pull/2258) 32 | 33 | ## Bug Fixes 34 | 35 | + TiKV 36 | 37 | - Fix the possible panic caused by transferring the leader when the Follower Read feature is enabled [#7101](https://github.com/tikv/tikv/pull/7101) 38 | -------------------------------------------------------------------------------- /content/docs/4.0/tasks/configure/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Configure 3 | description: Configure a wide range of TiKV facets, including RocksDB, gRPC, the Placement Driver, and more. 4 | menu: 5 | "4.0": 6 | parent: Tasks 7 | weight: 3 8 | --- 9 | 10 | TiKV features a large number of configuration parameters you can use to tweak TiKV's behavior. When getting started with TiKV, it's usually safe to start with the defaults, configuring only the `--pd` (`pd.endpoints`) option. 11 | 12 | There are several guides that you can use to inform your configuration: 13 | 14 | * [**Security**](../security): Use TLS security and review security procedures. 15 | * [**Topology**](../topology): Use location awareness to improve resiliency and performance. 16 | * [**Namespace**](../namespace): Use namespacing to configure resource isolation. 17 | * [**Limit**](../limit): Tweak rate limiting. 18 | * [**Region Merge**](../region-merge): Tweak region merging. 19 | * [**RocksDB**](../rocksdb): Tweak RocksDB configuration parameters. 20 | * [**Raftstore**](../raftstore): Tweak Raftstore configuration parameters. 21 | * [**Titan**](../titan): Enable titan to improve performance with large values. 22 | * [**PD**](../pd): Tweak PD parameters that are not included in command-line parameters. 23 | * [**Storage**](../storage): Tweak storage configuration parameters. 24 | * [**gRPC**](../grpc): Tweak gRPC configuration parameters. 25 | * [**Coprocessor**](../coprocessor): Tweak Coprocessor configuration parameters. 26 | 27 | You can find an exhaustive list of all parameters, as well as what they do, in the documented [**full configuration template**](https://github.com/tikv/tikv/blob/release-4.0/etc/config-template.toml). 28 | -------------------------------------------------------------------------------- /content/docs/3.0/tasks/deploy/docker-compose.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Docker Compose/Swarm 3 | description: Use Docker Compose or Swarm to quickly deploy a TiKV testing cluster. 4 | menu: 5 | "3.0": 6 | parent: Deploy 7 | weight: 5 8 | --- 9 | 10 | This guide describes how to deploy a single-node TiKV cluster using Docker Compose, or a multi-node TiKV cluster using Docker Swarm. 11 | 12 | {{< warning >}} 13 | The TiKV team strongly recommends you use the [**Ansible Deployment**](../ansible/) method. It is the method our team uses when we assist with deployment. 14 | 15 | Other methods are documented for informational purposes. We strongly recommend [consulting with our contributors](/chat) before depending on a cluster deployed without the Ansible scripts. 16 | {{< /warning >}} 17 | 18 | PingCAP (the original authors of TiKV, and a maintaining organization of TiKV), develops and maintains the Apache 2 licensed [TiDB docker-compose](https://github.com/pingcap/tidb-docker-compose). TiDB docker-compose is a collection of Docker Compose files which enable you to quickly 'test drive' TiKV as well as TiDB, TiSpark, and the monitoring tools. 19 | 20 | TiDB docker-compose is compatible with Linux as well as Mac and Windows through [Docker Desktop](https://www.docker.com/products/docker-desktop). 21 | 22 | We recommend using the [**Docker Swarm option**](https://github.com/pingcap/tidb-docker-compose#docker-swarm) option for using TiKV. If your Docker service is not able to support Swarm, the normal [Docker Compose](https://github.com/pingcap/tidb-docker-compose#quick-start) option requires some [manual configuration to interact with TiKV directly](https://github.com/pingcap/tidb-docker-compose#host-network-mode-linux) on non-Linux systems. -------------------------------------------------------------------------------- /content/docs/4.0/tasks/deploy/docker-compose.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Docker Compose/Swarm 3 | description: Use Docker Compose or Swarm to quickly deploy a TiKV testing cluster. 4 | menu: 5 | "4.0": 6 | parent: Deploy 7 | weight: 5 8 | --- 9 | 10 | This guide describes how to deploy a single-node TiKV cluster using Docker Compose, or a multi-node TiKV cluster using Docker Swarm. 11 | 12 | {{< warning >}} 13 | The TiKV team strongly recommends you use the [**Ansible Deployment**](../ansible/) method. It is the method our team uses when we assist with deployment. 14 | 15 | Other methods are documented for informational purposes. We strongly recommend [consulting with our contributors](/chat) before depending on a cluster deployed without the Ansible scripts. 16 | {{< /warning >}} 17 | 18 | PingCAP (the original authors of TiKV, and a maintaining organization of TiKV), develops and maintains the Apache 2 licensed [TiDB docker-compose](https://github.com/pingcap/tidb-docker-compose). TiDB docker-compose is a collection of Docker Compose files which enable you to quickly 'test drive' TiKV as well as TiDB, TiSpark, and the monitoring tools. 19 | 20 | TiDB docker-compose is compatible with Linux as well as Mac and Windows through [Docker Desktop](https://www.docker.com/products/docker-desktop). 21 | 22 | We recommend using the [**Docker Swarm option**](https://github.com/pingcap/tidb-docker-compose#docker-swarm) option for using TiKV. If your Docker service is not able to support Swarm, the normal [Docker Compose](https://github.com/pingcap/tidb-docker-compose#quick-start) option requires some [manual configuration to interact with TiKV directly](https://github.com/pingcap/tidb-docker-compose#host-network-mode-linux) on non-Linux systems. -------------------------------------------------------------------------------- /content/docs/5.1/deploy/configure/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Configure TiKV 3 | description: Configure a wide range of TiKV facets, including RocksDB, gRPC, the Placement Driver, and more. 4 | menu: 5 | "5.1": 6 | parent: Deploy 7 | weight: 2 8 | --- 9 | 10 | Although you are recommended to get started with TiKV using the default configuration, TiKV provides many configuration parameters to tweak its behavior, which allows you to configure the cluster to suit your special application requirements. 11 | 12 | The following list of documents guide you on how to configure different TiKV components: 13 | 14 | PD 15 | 16 | - [PD Command Line Parameters](../pd-command-line): Learn configuration flags of PD. 17 | - [PD Config](../pd-configuration-file): Learn the PD configuration file. 18 | 19 | TiKV 20 | 21 | - [TiKV Command Line Parameters](../tikv-command-line): Learn configuration flags of TiKV. 22 | - [TiKV Config](../tikv-configuration-file): Learn the TiKV configuration file. 23 | - [Security](../security): Use TLS security and review security procedures. 24 | - [Topology Lable](../topology): Use location awareness to improve resiliency and performance. 25 | - [Limit](../limit): Learn how to configure scheduling rate limit on stores. 26 | - [Region Merge](../region-merge): Tweak Region merging. 27 | - [RocksDB](../rocksdb): Tweak RocksDB configuration parameters. 28 | - [Raftstore](../raftstore): Learn how to configure Raftstore in TiKV. 29 | - [Titan](../titan): Enable Titan to improve performance with large values. 30 | - [Storage](../storage): Learn how to configure storage in TiKV. 31 | - [gRPC](../grpc): Learn how to configure gRPC in TiKV. 32 | - [Coprocessor](../coprocessor): Learn how to configure Coprocessor in TiKV. 33 | -------------------------------------------------------------------------------- /data/features.yaml: -------------------------------------------------------------------------------- 1 | - name: Low and stable latency 2 | description: RawKV’s average response time less than 1 ms (P99=10 ms). 3 | icon: img/homepage/low-latency.svg 4 | featured: true 5 | - name: High scalability 6 | description: With the [Placement Driver](/docs/5.1/reference/architecture/terminology/#placement-driver-pd) and carefully designed [Raft](https://raft.github.io/) groups, TiKV excels in horizontal scalability and can easily scale to 100+ terabytes of data. Scale-out your TiKV cluster to fit the data size growth without any impact on the application. 7 | icon: img/homepage/high-scalability.svg 8 | featured: true 9 | - name: Easy to use 10 | description: Run a single command to deploy a TiKV cluster with everything you need for production environments. Easily scale out or scale in the cluster with [TiUP](/docs/5.1/reference/tiup/) or TiKV operator. 11 | icon: img/homepage/easy-to-use.svg 12 | featured: true 13 | - name: Easy to maintain 14 | description: TiKV is based on the design of [Google Spanner](https://research.google/pubs/pub39966/) and [HBase](https://hbase.apache.org/), but simpler to manage without dependencies on any distributed file system. 15 | icon: img/homepage/easy-to-maintain.svg 16 | featured: true 17 | - name: Consistent distributed transactions 18 | description: Similar to Google’s [Spanner](https://research.google/pubs/pub39966/), TiKV (TxnKV mode) supports externally consistent distributed transactions. 19 | icon: img/homepage/consistent-distributed-transactions.svg 20 | featured: true 21 | - name: Adjustable consistency 22 | description: In RawKV and TxnKV modes, you can customize the balance between consistency and performance. 23 | icon: img/homepage/adjustable-consistency.svg 24 | featured: true 25 | -------------------------------------------------------------------------------- /content/docs/6.1/deploy/configure/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Configure TiKV 3 | description: Configure a wide range of TiKV facets, including RocksDB, gRPC, the Placement Driver, and more. 4 | menu: 5 | "6.1": 6 | parent: Deploy-v6.1 7 | weight: 2 8 | identifier: Configure TiKV-v6.1 9 | --- 10 | 11 | Although you are recommended to get started with TiKV using the default configuration, TiKV provides many configuration parameters to tweak its behavior, which allows you to configure the cluster to suit your special application requirements. 12 | 13 | The following list of documents guide you on how to configure different TiKV components: 14 | 15 | PD 16 | 17 | - [PD Command Line Parameters](../pd-command-line): Learn configuration flags of PD. 18 | - [PD Config](../pd-configuration-file): Learn the PD configuration file. 19 | 20 | TiKV 21 | 22 | - [TiKV Command Line Parameters](../tikv-command-line): Learn configuration flags of TiKV. 23 | - [TiKV Config](../tikv-configuration-file): Learn the TiKV configuration file. 24 | - [Security](../security): Use TLS security and review security procedures. 25 | - [Topology Lable](../topology): Use location awareness to improve resiliency and performance. 26 | - [Limit](../limit): Learn how to configure scheduling rate limit on stores. 27 | - [Region Merge](../region-merge): Tweak Region merging. 28 | - [RocksDB](../rocksdb): Tweak RocksDB configuration parameters. 29 | - [Raftstore](../raftstore): Learn how to configure Raftstore in TiKV. 30 | - [Titan](../titan): Enable Titan to improve performance with large values. 31 | - [Storage](../storage): Learn how to configure storage in TiKV. 32 | - [gRPC](../grpc): Learn how to configure gRPC in TiKV. 33 | - [Coprocessor](../coprocessor): Learn how to configure Coprocessor in TiKV. 34 | -------------------------------------------------------------------------------- /content/docs/6.5/deploy/configure/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Configure TiKV 3 | description: Configure a wide range of TiKV facets, including RocksDB, gRPC, the Placement Driver, and more. 4 | menu: 5 | "6.5": 6 | parent: Deploy-6.5 7 | weight: 2 8 | identifier: Configure TiKV-6.5 9 | --- 10 | 11 | Although you are recommended to get started with TiKV using the default configuration, TiKV provides many configuration parameters to tweak its behavior, which allows you to configure the cluster to suit your special application requirements. 12 | 13 | The following list of documents guide you on how to configure different TiKV components: 14 | 15 | PD 16 | 17 | - [PD Command Line Parameters](../pd-command-line): Learn configuration flags of PD. 18 | - [PD Config](../pd-configuration-file): Learn the PD configuration file. 19 | 20 | TiKV 21 | 22 | - [TiKV Command Line Parameters](../tikv-command-line): Learn configuration flags of TiKV. 23 | - [TiKV Config](../tikv-configuration-file): Learn the TiKV configuration file. 24 | - [Security](../security): Use TLS security and review security procedures. 25 | - [Topology Lable](../topology): Use location awareness to improve resiliency and performance. 26 | - [Limit](../limit): Learn how to configure scheduling rate limit on stores. 27 | - [Region Merge](../region-merge): Tweak Region merging. 28 | - [RocksDB](../rocksdb): Tweak RocksDB configuration parameters. 29 | - [Raftstore](../raftstore): Learn how to configure Raftstore in TiKV. 30 | - [Titan](../titan): Enable Titan to improve performance with large values. 31 | - [Storage](../storage): Learn how to configure storage in TiKV. 32 | - [gRPC](../grpc): Learn how to configure gRPC in TiKV. 33 | - [Coprocessor](../coprocessor): Learn how to configure Coprocessor in TiKV. 34 | -------------------------------------------------------------------------------- /content/docs/7.1/deploy/configure/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Configure TiKV 3 | description: Configure a wide range of TiKV facets, including RocksDB, gRPC, the Placement Driver, and more. 4 | menu: 5 | "7.1": 6 | parent: Deploy-7.1 7 | weight: 2 8 | identifier: Configure TiKV-7.1 9 | --- 10 | 11 | Although you are recommended to get started with TiKV using the default configuration, TiKV provides many configuration parameters to tweak its behavior, which allows you to configure the cluster to suit your special application requirements. 12 | 13 | The following list of documents guide you on how to configure different TiKV components: 14 | 15 | PD 16 | 17 | - [PD Command Line Parameters](../pd-command-line): Learn configuration flags of PD. 18 | - [PD Config](../pd-configuration-file): Learn the PD configuration file. 19 | 20 | TiKV 21 | 22 | - [TiKV Command Line Parameters](../tikv-command-line): Learn configuration flags of TiKV. 23 | - [TiKV Config](../tikv-configuration-file): Learn the TiKV configuration file. 24 | - [Security](../security): Use TLS security and review security procedures. 25 | - [Topology Lable](../topology): Use location awareness to improve resiliency and performance. 26 | - [Limit](../limit): Learn how to configure scheduling rate limit on stores. 27 | - [Region Merge](../region-merge): Tweak Region merging. 28 | - [RocksDB](../rocksdb): Tweak RocksDB configuration parameters. 29 | - [Raftstore](../raftstore): Learn how to configure Raftstore in TiKV. 30 | - [Titan](../titan): Enable Titan to improve performance with large values. 31 | - [Storage](../storage): Learn how to configure storage in TiKV. 32 | - [gRPC](../grpc): Learn how to configure gRPC in TiKV. 33 | - [Coprocessor](../coprocessor): Learn how to configure Coprocessor in TiKV. 34 | -------------------------------------------------------------------------------- /content/docs/dev/deploy/configure/introduction.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Configure TiKV 3 | description: Configure a wide range of TiKV facets, including RocksDB, gRPC, the Placement Driver, and more. 4 | menu: 5 | "dev": 6 | parent: Deploy-dev 7 | weight: 2 8 | identifier: Configure TiKV-dev 9 | --- 10 | 11 | Although you are recommended to get started with TiKV using the default configuration, TiKV provides many configuration parameters to tweak its behavior, which allows you to configure the cluster to suit your special application requirements. 12 | 13 | The following list of documents guide you on how to configure different TiKV components: 14 | 15 | PD 16 | 17 | - [PD Command Line Parameters](../pd-command-line): Learn configuration flags of PD. 18 | - [PD Config](../pd-configuration-file): Learn the PD configuration file. 19 | 20 | TiKV 21 | 22 | - [TiKV Command Line Parameters](../tikv-command-line): Learn configuration flags of TiKV. 23 | - [TiKV Config](../tikv-configuration-file): Learn the TiKV configuration file. 24 | - [Security](../security): Use TLS security and review security procedures. 25 | - [Topology Lable](../topology): Use location awareness to improve resiliency and performance. 26 | - [Limit](../limit): Learn how to configure scheduling rate limit on stores. 27 | - [Region Merge](../region-merge): Tweak Region merging. 28 | - [RocksDB](../rocksdb): Tweak RocksDB configuration parameters. 29 | - [Raftstore](../raftstore): Learn how to configure Raftstore in TiKV. 30 | - [Titan](../titan): Enable Titan to improve performance with large values. 31 | - [Storage](../storage): Learn how to configure storage in TiKV. 32 | - [gRPC](../grpc): Learn how to configure gRPC in TiKV. 33 | - [Coprocessor](../coprocessor): Learn how to configure Coprocessor in TiKV. 34 | -------------------------------------------------------------------------------- /content/docs/5.1/deploy/configure/region-merge.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Region Merge Config 3 | description: Learn how to configure Region Merge in TiKV. 4 | menu: 5 | "5.1": 6 | parent: Configure TiKV 7 | weight: 7 8 | --- 9 | 10 | TiKV shards continuous ranges of keys into Regions, and replicates Regions through the Raft protocol. When data size increases until reaching a threshold, a Region splits into multiple. Conversely, if the size of the Region shrinks due to data deletion, two adjacent Regions can be merged into one. 11 | 12 | ## Region Merge 13 | 14 | The Region Merge process is initiated by PD as follows: 15 | 16 | 1. PD polls the status of the Regions by the interval. 17 | 18 | 2. PD ensures all replicas of the two Regions to be merged must be stored on the same set of TiKV(s). 19 | 20 | 3. If the sizes of two adjacent regions are both less than `max-merge-region-size` and the numbers of keys within the regions are both less than `max-merge-region-keys`, PD starts the Region Merge process that merges the bigger region into the smaller region. 21 | 22 | ## Configure Region Merge 23 | 24 | You can use `pd-ctl` or the PD configuration file to configure Region Merge. 25 | 26 | The Region Merge feature is enabled by default. To disable Region Merge, you need to set the following parameters to zero: 27 | 28 | - `max-merge-region-size` 29 | - `max-merge-region-keys` 30 | - `merge-schedule-limit` 31 | 32 | {{< info >}} 33 | - Newly split Regions are not merged within the period specified by `split-merge-interval`. 34 | - Region Merge does not happen within the period specified by `split-merge-interval` after PD starts or restarts. 35 | {{< /info >}} 36 | 37 | For more information of other configuration parameters about scheduling, see [Scheduling-related parameters](../pd-configuration-file/#schedule). --------------------------------------------------------------------------------