valkeyダウンロード - valkeyソースコードのダウンロード

valkey

その他のソースコード

8.0.1

ダウンロード

このプロジェクトは、新しいソースの利用可能なライセンスに移行する直前に、オープンソースの Redis プロジェクトから分岐されました。

この README は単なるクイックスタートドキュメントです。詳細については、valkey.io を参照してください。

ヴァルキーって何？

Valkey は、主にキー/値ワークロードを処理する高性能データ構造サーバーです。幅広いネイティブ構造と、新しいデータ構造とアクセスパターンを追加するための拡張可能なプラグインシステムをサポートします。

`Makefile`使用して Valkey をビルドする

Valkey は、Linux、OSX、OpenBSD、NetBSD、FreeBSD 上でコンパイルして使用できます。ビッグエンディアンとリトルエンディアンのアーキテクチャ、および 32 ビットと 64 ビットの両方のシステムをサポートしています。

Solaris 派生システム (SmartOS など) でコンパイルできますが、このプラットフォームのサポートはベストエフォートであり、Valkey が Linux、OSX、および *BSD と同様に動作することは保証されていません。

それは次のように簡単です。

 % make

TLS サポートを使用してビルドするには、OpenSSL 開発ライブラリ (例: Debian/Ubuntu の libssl-dev) が必要です。

TLS サポートを Valkey 組み込みとして構築するには:

 % make BUILD_TLS=yes

TLS を Valkey モジュールとして構築するには:

 % make BUILD_TLS=module

センチネルモードは TLS モジュールをサポートしていないことに注意してください。

実験的な RDMA サポートを使用してビルドするには、RDMA 開発ライブラリ (例: Debian/Ubuntu の librdmacm-dev および libibverbs-dev) が必要です。現時点では、Valkey は接続モジュールモードとして RDMA のみをサポートしています。走る：

 % make BUILD_RDMA=module

systemd サポートを使用してビルドするには、systemd 開発ライブラリ (Debian/Ubuntu の libsystemd-dev や CentOS の systemd-devel など) が必要で、以下を実行します。

 % make USE_SYSTEMD=yes

Valkey プログラム名にサフィックスを追加するには、次を使用します。

 % make PROG_SUFFIX="-alt"

以下を使用して 32 ビット Valkey バイナリを構築できます。

 % make 32bit

Valkey を構築した後、以下を使用してテストすることをお勧めします。

 % make test

上記はメインの統合テストを実行します。追加のテストは以下を使用して開始されます。

 % make test-unit     # Unit tests
% make test-modules  # Tests of the module API
% make test-sentinel # Valkey Sentinel integration tests
% make test-cluster  # Valkey Cluster integration tests

統合テストの実行の詳細については、tests/README.md を参照してください。単体テストについては、src/unit/README.md を参照してください。

依存関係またはキャッシュされたビルドオプションに関するビルドの問題を修正する

Valkey には、 depsディレクトリに含まれる依存関係がいくつかあります。 make依存関係のソースコード内の何かが変更された場合でも、依存関係を自動的に再構築しません。

git pullを使用してソースコードを更新する場合、または依存関係ツリー内のコードが他の方法で変更される場合は、すべてを実際にクリーンアップして最初から再構築するために、必ず次のコマンドを使用してください。

 % make distclean

これにより、jemalloc、lua、hiredis、linenoise、その他の依存関係が削除されます。

また、32 ビットターゲット、C コンパイラの最適化なし (デバッグ目的)、およびその他の同様のビルド時オプションなどの特定のビルドオプションを強制した場合、これらのオプションはmake distcleanコマンドを発行するまで無期限にキャッシュされます。

32 ビットバイナリの構築に関する問題の修正

32 ビットターゲットで Valkey をビルドした後、64 ビットターゲットで再ビルドする必要がある場合、またはその逆の場合は、Valkey ディストリビューションのルートディレクトリでmake distclean実行する必要があります。

Valkey の 32 ビットバイナリをビルドしようとしたときにビルドエラーが発生した場合は、次の手順を試してください。

パッケージ libc6-dev-i386 をインストールします (g++-multilib も試してください)。
make 32bitの代わりに次のコマンドラインを使用してみてください: make CFLAGS="-m32 -march=native" LDFLAGS="-m32"

アロケータ

Valkey のビルド時にデフォルト以外のメモリアロケータを選択するには、 MALLOC環境変数を設定します。 Linux システムのデフォルトである jemalloc を除き、Valkey はデフォルトで libc malloc に対してコンパイルおよびリンクされます。このデフォルトが選択されたのは、jemalloc の方が libc malloc よりも断片化の問題が少ないことが証明されているためです。

libc malloc に対して強制的にコンパイルするには、次を使用します。

 % make MALLOC=libc

Mac OS X システムで jemalloc に対してコンパイルするには、次を使用します。

 % make MALLOC=jemalloc

単調時計

デフォルトでは、Valkey は POSIX の Clock_gettime 関数を単調クロックソースとして使用してビルドします。最新のシステムでは、内部プロセッサクロックを使用してパフォーマンスを向上させることができます。注意事項はこちらでご覧いただけます: http://oliveryang.net/2015/09/pitfalls-of-TSC-usage/

プロセッサの内部命令クロックをサポートしてビルドするには、次を使用します。

 % make CFLAGS="-DUSE_PROCESSOR_CLOCK"

冗長ビルド

Valkey は、デフォルトでユーザーフレンドリーな色付き出力を使用してビルドします。より詳細な出力を表示したい場合は、次を使用します。

 % make V=1

ランニングヴァルキー

Valkey をデフォルト設定で実行するには、次のように入力します。

 % cd src
% ./valkey-server

valkey.conf を提供する場合は、追加のパラメーター (構成ファイルのパス) を使用して実行する必要があります。

 % cd src
% ./valkey-server /path/to/valkey.conf

コマンドラインを使用してパラメーターをオプションとして直接渡すことにより、Valkey 構成を変更できます。例:

 % ./valkey-server --port 9999 --replicaof 127.0.0.1 6379
% ./valkey-server /etc/valkey/6379.conf --loglevel debug

valkey.conf 内のすべてのオプションは、まったく同じ名前でコマンドラインを使用するオプションとしてもサポートされています。

TLS を使用して Valkey を実行する:

手動で実行する

TLS モードで Valkey サーバーを手動で実行するには ( ./gen-test-certs.shが呼び出され、サンプル証明書/キーが利用可能であると仮定します):

TLS 組み込みモード:

 ./src/valkey-server --tls-port 6379 --port 0 
    --tls-cert-file ./tests/tls/valkey.crt 
    --tls-key-file ./tests/tls/valkey.key 
    --tls-ca-cert-file ./tests/tls/ca.crt

TLSモジュールモード:

 ./src/valkey-server --tls-port 6379 --port 0 
    --tls-cert-file ./tests/tls/valkey.crt 
    --tls-key-file ./tests/tls/valkey.key 
    --tls-ca-cert-file ./tests/tls/ca.crt 
    --loadmodule src/valkey-tls.so

--port 0明示的に指定すると、TCP を無効にできることに注意してください。 TCP と TLS の両方を同時に使用可能にすることもできますが、異なるポートを割り当てる必要があります。

valkey-cli使用して Valkey サーバーに接続します。

 ./src/valkey-cli --tls 
    --cert ./tests/tls/valkey.crt 
    --key ./tests/tls/valkey.key 
    --cacert ./tests/tls/ca.crt

--tls-replication yes指定すると、レプリカがプライマリに接続されます。

--tls-cluster yes使用すると、Valkey Cluster がノード間で TLS を使用するようになります。

RDMA を使用して Valkey を実行する:

Valkey Over RDMA は実験的な機能であることに注意してください。マイナーバージョンまたはメジャーバージョンで変更または削除される可能性があります。現在、Linux でのみサポートされています。

Valkey サーバーを RDMA モードで手動で実行するには:

 % ./src/valkey-server --protected-mode no 
     --loadmodule src/valkey-rdma.so bind=192.168.122.100 port=6379

実行時コマンドによって RDMA のバインドアドレス/ポートを変更することができます。

 192.168.122.100:6379> CONFIG SET rdma.port 6380

RDMA と TCP の両方を使用することも可能で、TCP(6379) と RDMA(6379) の競合はありません。例:

 % ./src/valkey-server --protected-mode no 
     --loadmodule src/valkey-rdma.so bind=192.168.122.100 port=6379 
     --port 6379

ネットワークカード (この例では 192.168.122.100) は RDMA をサポートしている必要があることに注意してください。サーバーが RDMA をサポートしているかどうかをテストするには、次のようにします。

 % rdma res show (a new version iproute2 package)

または：

 % ibv_devices

ヴァルキーと遊ぶ

valkey-cli を使用して Valkey で遊ぶことができます。 valkey-server インスタンスを起動し、別の端末で次のことを試してください。

 % cd src
% ./valkey-cli
valkey> ping
PONG
valkey> set foo bar
OK
valkey> get foo
"bar"
valkey> incr mycounter
(integer) 1
valkey> incr mycounter
(integer) 2
valkey>

Valkeyのインストール

Valkey バイナリを /usr/local/bin にインストールするには、次のコマンドを使用します。

 % make install

別の宛先を使用したい場合は、 make PREFIX=/some/other/directory install使用できます。

注: Redis との互換性のために、Redis 名 ( redis-server 、 redis-cliなど) からmake installによってインストールされた Valkey バイナリへのシンボリックリンクを作成します。シンボリックリンクは、Valkey バイナリと同じディレクトリに作成されます。シンボリックリンクは、 make uninstall使用すると削除されます。シンボリックリンクの作成は、メイクファイル変数USE_REDIS_SYMLINKS=noを設定することでスキップできます。

make installシステムにバイナリをインストールするだけで、適切な場所に init スクリプトや設定ファイルを設定しません。 Valkey を少し試してみたいだけの場合はこれは必要ありませんが、運用システムに適切な方法でインストールする場合は、Ubuntu および Debian システム用にこれを行うスクリプトがあります。

 % cd utils
% ./install_server.sh

注: install_server.sh Mac OSX では動作しません。 Linux 専用に構築されています。

スクリプトはいくつかの質問をし、システムの再起動時に再び起動するバックグラウンドデーモンとして Valkey を適切に実行するために必要なものをすべてセットアップします。

/etc/init.d/valkey_<portnumber>という名前のスクリプト ( /etc/init.d/valkey_6379など) を使用して、Valkey を停止および起動できます。

`CMake`使用したビルド

従来のMakefileビルドに加えて、Valkey はCMake使用した代替の実験的なビルドシステムをサポートしています。

Valkeyをビルドしてインストールするには、 Releaseモード (最適化されたビルド) で、ターミナルに次のように入力します。

mkdir build-release
cd $_
cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/opt/valkey
sudo make install
# Valkey is now installed under /opt/valkey

Valkey のCMakeビルドシステムでサポートされているその他のオプション:

特別なビルドフラグ

-DBUILD_TLS=<on|off|module> Valkey の TLS ビルドを有効にする
-DBUILD_RDMA=<off|module> RDMA モジュールのビルドを有効にします (モジュールモードのみサポート)
-DBUILD_MALLOC=<libc|jemalloc|tcmalloc|tcmalloc_minimal>使用するアロケーターを選択します。 Linux のデフォルト: jemalloc 、他の OS のデフォルト: libc
-DBUILD_SANITIZER=<address|thread|undefined>アドレスサニタイザーを有効にしてビルドします
-DBUILD_UNIT_TESTS=[1|0]を設定すると、ビルドにより実行可能ファイルvalkey-unit-testsが生成されます。
-DBUILD_TEST_MODULES=[1|0]を設定すると、ビルドにはtests/modulesフォルダーの下にあるモジュールが含まれます。
-DBUILD_EXAMPLE_MODULES=[1|0]設定すると、ビルドにはsrc/modulesフォルダーの下にあるサンプルモジュールが含まれます。

共通フラグ

-DCMAKE_BUILD_TYPE=<Debug|Release...>ビルドタイプを定義します。詳細については、CMake マニュアルを参照してください。
-DCMAKE_INSTALL_PREFIX=/installation/pathこの値をオーバーライドして、カスタムインストールプレフィックスを定義します。デフォルト: /usr/local
-G<Generator Name> 「ジェネレータ名」のビルドファイルを生成します。デフォルトでは、CMake はMakefile生成します。

冗長ビルド

CMake 、デフォルトでユーザーフレンドリーな色付き出力を生成します。より詳細な出力を表示したい場合は、次を使用します。

make VERBOSE=1

トラブルシューティング

CMakeステージでは、 CMake変数をCMakeCache.txtという名前のローカルファイルにキャッシュします。 Valkey によって生成されたすべての変数は、消費されるとキャッシュから削除されます (これはunset(VAR-NAME CACHE)を呼び出すことによって行われます)。ただし、コンパイラパスなどの一部の変数はキャッシュに保持されます。新しいビルドを開始するには、キャッシュファイルCMakeCache.txtをビルドフォルダーから削除するか、ビルドフォルダーを完全に削除します。

新しいソースファイルを追加するときは、 CMake再実行することが重要です。

IDEとの統合

ビルドのCMake段階で、 CMake compile_commands.jsonという名前の JSON ファイルを生成し、それをビルドフォルダーの下に配置します。このファイルは、( clangd経由で) コード補完を提供するために多くの IDE およびテキストエディターで使用されます。

小さな注意点は、これらのツールは Valkey の最上位フォルダーの下にあるcompile_commands.jsonを検索することです。一般的な回避策は、そのへのシンボリックリンクを作成することです。

 cd /path/to/valkey/
# We assume here that your build folder is `build-release`
ln -sf $( pwd ) /build-release/compile_commands.json $( pwd ) /compile_commands.json

IDE を再起動すれば出来上がりです

コードの貢献

COTRIBUTING.md を参照してください。セキュリティのバグと脆弱性については、SECURITY.md を参照してください。

Valkey は、LF Projects のオープンコミュニティプロジェクトです。

Valkey a Series of LF Projects, LLC 2810 N Church St, PMB 57274 Wilmington, Delaware 19802-4447

拡大する

追加情報

バージョン 8.0.1
タイプその他のソースコード
更新時間 2025-01-08
サイズ 50MB
から Github

valkey

ヴァルキーって何？

`Makefile`使用して Valkey をビルドする

依存関係またはキャッシュされたビルドオプションに関するビルドの問題を修正する

32 ビットバイナリの構築に関する問題の修正

アロケータ

単調時計

冗長ビルド

ランニングヴァルキー

TLS を使用して Valkey を実行する:

手動で実行する

RDMA を使用して Valkey を実行する:

ヴァルキーと遊ぶ

Valkeyのインストール

`CMake`使用したビルド

特別なビルドフラグ

共通フラグ

冗長ビルド

トラブルシューティング

IDEとの統合

コードの貢献

Valkey は、LF Projects のオープンコミュニティプロジェクトです。

waymo open dataset

SmartTube

Sunamu

viptools for eslam

MySchedule.py

VITAident

chat.petals.dev

GPT Prompt Templates

GPTyped

waymo open dataset

SmartTube

Sunamu

wp functions

waymo open dataset

slugify

valkey

ヴァルキーって何？

Makefile使用して Valkey をビルドする

依存関係またはキャッシュされたビルド オプションに関するビルドの問題を修正する

32 ビット バイナリの構築に関する問題の修正

アロケータ

単調時計

冗長ビルド

ランニングヴァルキー

TLS を使用して Valkey を実行する:

手動で実行する

RDMA を使用して Valkey を実行する:

ヴァルキーと遊ぶ

Valkeyのインストール

CMake使用したビルド

特別なビルドフラグ

共通フラグ

冗長ビルド

トラブルシューティング

IDEとの統合

コードの貢献

Valkey は、LF Projects のオープン コミュニティ プロジェクトです。

`Makefile`使用して Valkey をビルドする

依存関係またはキャッシュされたビルドオプションに関するビルドの問題を修正する

32 ビットバイナリの構築に関する問題の修正

`CMake`使用したビルド

Valkey は、LF Projects のオープンコミュニティプロジェクトです。