{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/344", "result": {"data":{"issuesJson":{"id":"912eff57-dfbc-586a-8ced-cfccb0ccd3c1","title":"apache/kvrocks: 一个分布式键值 NoSQL 数据库，使用 RocksDB 作为存储引擎，兼容 Redis 协议。","number":344,"bodyHTML":"
\n



\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Reposapache/kvrocks
Views\"views\"
Stars\"stars\"
Forks\"forks\"
License\"license\"
UpdatedAt\"last-commit\"
CreatedAt\"create-at\"
\n\n

\"\"

\n\n
\n\n

\"kvrocks_logo\"

\n

\"CI\"
\n\"License\"
\n\"GitHub

\n
\n\n

Apache Kvrocks is a distributed key value NoSQL database that uses RocksDB as storage engine and is compatible with Redis protocol. Kvrocks intends to decrease the cost of memory and increase the capacity while compared to Redis. The design of replication and storage was inspired by rocksplicator and blackwidow.

\n

Kvrocks has the following key features:

\n\n

Who uses Kvrocks

\n

You can find Kvrocks users at the Users page.

\n

Users are encouraged to add themselves to the Users page. Either leave a comment on the \"Who is using Kvrocks\" issue, or directly send a pull request to add company or organization information and logo.

\n

Build and run Kvrocks

\n

Prerequisite

\n
# Ubuntu / Debian\nsudo apt update\nsudo apt install -y git build-essential cmake libtool python3 libssl-dev\n\n# CentOS / RedHat\nsudo yum install -y centos-release-scl-rh\nsudo yum install -y git devtoolset-11 autoconf automake libtool libstdc++-static python3 openssl-devel\n# download and install cmake via https://cmake.org/download\nwget https://github.com/Kitware/CMake/releases/download/v3.26.4/cmake-3.26.4-linux-x86_64.sh -O cmake.sh\nsudo bash cmake.sh --skip-license --prefix=/usr\n# enable gcc and make in devtoolset-11\nsource /opt/rh/devtoolset-11/enable\n\n# openSUSE / SUSE Linux Enterprise\nsudo zypper install -y gcc11 gcc11-c++ make wget git autoconf automake python3 curl cmake\n\n# Arch Linux\nsudo pacman -Sy --noconfirm autoconf automake python3 git wget which cmake make gcc\n\n# macOS\nbrew install git cmake autoconf automake libtool openssl\n# please link openssl by force if it still cannot be found after installing\nbrew link --force openssl
\n

Build

\n

It is as simple as:

\n
$ git clone https://github.com/apache/kvrocks.git\n$ cd kvrocks\n$ ./x.py build # `./x.py build -h` to check more options;\n               # especially, `./x.py build --ghproxy` will fetch dependencies via ghproxy.com.
\n

To build with TLS support, you'll need OpenSSL development libraries (e.g. libssl-dev on Debian/Ubuntu) and run:

\n
$ ./x.py build -DENABLE_OPENSSL=ON
\n

To build with lua instead of luaJIT, run:

\n
$ ./x.py build -DENABLE_LUAJIT=OFF
\n

Build with debug mode, run:

\n
# The default build type is RelWithDebInfo and its optimization level is typically -O2.\n# You can change it to -O0 in debug mode.\n\n$ ./x.py build -DCMAKE_BUILD_TYPE=Debug
\n

Running Kvrocks

\n
$ ./build/kvrocks -c kvrocks.conf
\n

Running Kvrocks using Docker

\n
$ docker run -it -p 6666:6666 apache/kvrocks --bind 0.0.0.0\n# or get the nightly image:\n$ docker run -it -p 6666:6666 apache/kvrocks:nightly
\n

Please visit Apache Kvrocks on DockerHub for additional details about images.

\n

Connect Kvrocks service

\n
$ redis-cli -p 6666\n\n127.0.0.1:6666> get a\n(nil)
\n

Running test cases

\n
$ ./x.py build --unittest\n$ ./x.py test cpp # run C++ unit tests\n$ ./x.py test go # run Golang (unit and integration) test cases
\n

Supported platforms

\n\n

Namespace

\n

Namespace is used to isolate data between users. Unlike all the Redis databases can be visited by requirepass, we use one token per namespace. requirepass is regraded as admin token, and only admin token allows to access the namespace command, as well as some commands like config, slaveof, bgsave, etc. See the Namespace page for more details.

\n
# add token\n127.0.0.1:6666> namespace add ns1 my_token\nOK\n\n# update token\n127.0.0.1:6666> namespace set ns1 new_token\nOK\n\n# list namespace\n127.0.0.1:6666> namespace get *\n1) \"ns1\"\n2) \"new_token\"\n3) \"__namespace\"\n4) \"foobared\"\n\n# delete namespace\n127.0.0.1:6666> namespace del ns1\nOK
\n

Cluster

\n

Kvrocks implements a proxyless centralized cluster solution but its accessing method is completely compatible with Redis cluster clients. You can use Redis cluster SDKs to access the kvrocks cluster. For more details, please refer to Kvrocks Cluster Introduction.

\n

Documents

\n

Documents are hosted at the official website.

\n\n

Tools

\n\n

Contributing

\n

Kvrocks community welcomes all forms of contribution and you can find out how to get involved on the Community and How to Contribute pages.

\n

License

\n

Apache Kvrocks is licensed under the Apache License Version 2.0. See LICENSE and NOTICE for details.

\n

Social Media

\n\n

\"WeChat

","updatedAt":"2025-05-21T16:09:47Z","upvoteCount":null,"author":{"login":"eryajf","avatarUrl":"https://avatars.githubusercontent.com/u/33259379?u=e4a4090a38ac2473aaed4ef9945233636776c6c3&v=4","url":"https://github.com/eryajf"},"category":null,"labels":{"edges":[{"node":{"name":"更多","color":"25B472"}},{"node":{"name":"apache","color":"a17117"}},{"node":{"name":"Database","color":"3fbc9d"}}]},"comments":{"edges":[]}}},"pageContext":{"number":344,"previous":{"title":"huichen/kunlun: 基于 Golang 实现的 Git 仓库代码搜索引擎，只支持检索本地代码仓库","number":343},"next":{"title":"kubernetes-sigs/kwok: 一个没有 Kubelet 的 Kubernetes， 你可以在笔记本电脑上在几秒钟内模拟数千个节点，而不会大量消耗 CPU 或内存资源。且兼容 K8S API","number":345}}}, "staticQueryHashes": ["151096407","2861350382"]}