Valkey

https://valkey.io/
Admin
Valkey is an open-source, high-performance in-memory data structure store that serves as a database,...
Tokens:1,156,356
Snippets:8,717
Trust Score:9.8
Update:3 days ago
Show doc for...
Tokens:
Raw
### Start Valkey with command-line arguments

Source: https://valkey.io/topics/valkey.conf

Example of starting a Valkey instance with specific port and replica settings via the command line.

```bash
./valkey-server --port 6380 --replicaof 127.0.0.1 6379
```

--------------------------------

### GET command usage examples

Source: https://valkey.io/commands/get

Demonstrates retrieving a non-existent key, setting a key, and retrieving the value of an existing key.

```text
127.0.0.1:6379> GET nonexisting
(nil)
127.0.0.1:6379> SET mykey "Hello"
OK
127.0.0.1:6379> GET mykey
"Hello"
```

--------------------------------

### Install valkey-go

Source: https://valkey.io/clients

Use this command to install the valkey-go client library.

```bash
go get github.com/valkey-io/valkey-go
```

--------------------------------

### Example configuration directive

Source: https://valkey.io/topics/valkey.conf

A standard example of a replicaof directive in valkey.conf.

```text
replicaof 127.0.0.1 6380
```

--------------------------------

### Start Valkey service

Source: https://valkey.io/topics/installation

Start the Valkey instance using the init script.

```bash
sudo /etc/init.d/valkey_6379 start
```

--------------------------------

### Start valkey-server with a configuration file

Source: https://valkey.io/topics/server

Initializes the server using a specific configuration file path.

```bash
valkey-server /etc/valkey/6379.conf
```

--------------------------------

### Prefix Matching Examples

Source: https://valkey.io/topics/search-query

Matches any word that starts with the specified term using a trailing asterisk.

```text
hello*                  matches words that start with hello such as hello, hello1, hello_world but not ohello
@t:hello*               matches words that start with hello in the t field (t must be a text field)
```

--------------------------------

### Retrieve command information

Source: https://valkey.io/commands/command-info

Example showing how to request details for specific commands like get, set, and eval.

```text
127.0.0.1:6379> COMMAND INFO get set eval
1)  1) "get"
    2) (integer) 2
    3) 1) readonly
       2) fast
    4) (integer) 1
    5) (integer) 1
    6) (integer) 1
    7) 1) @read
       2) @string
       3) @fast
    8) (empty array)
    9) 1) 1) "flags"
          2) 1) RO
             2) access
          3) "begin_search"
          4) 1) "type"
             2) "index"
             3) "spec"
             4) 1) "index"
                2) (integer) 1
          5) "find_keys"
          6) 1) "type"
             2) "range"
             3) "spec"
             4) 1) "lastkey"
                2) (integer) 0
                3) "keystep"
                4) (integer) 1
                5) "limit"
                6) (integer) 0
   10) (empty array)
2)  1) "set"
    2) (integer) -3
    3) 1) write
       2) denyoom
    4) (integer) 1
    5) (integer) 1
    6) (integer) 1
    7) 1) @write
       2) @string
       3) @slow
    8) (empty array)
    9) 1) 1) "notes"
          2) "RW and ACCESS due to the optional `GET` argument"
          3) "flags"
          4) 1) RW
             2) access
             3) update
             4) variable_flags
          5) "begin_search"
          6) 1) "type"
             2) "index"
             3) "spec"
             4) 1) "index"
                2) (integer) 1
          7) "find_keys"
          8) 1) "type"
             2) "range"
             3) "spec"
             4) 1) "lastkey"
                2) (integer) 0
                3) "keystep"
                4) (integer) 1
                5) "limit"
                6) (integer) 0
   10) (empty array)
3)  1) "eval"
    2) (integer) -3
    3) 1) noscript
       2) stale
       3) skip_monitor
       4) no_mandatory_keys
       5) movablekeys
    4) (integer) 0
    5) (integer) 0
    6) (integer) 0
    7) 1) @slow
       2) @scripting
    8) (empty array)
    9) 1) 1) "notes"
          2) "We cannot tell how the keys will be used so we assume the worst, RW and UPDATE"
          3) "flags"
          4) 1) RW
             2) access
             3) update
          5) "begin_search"
          6) 1) "type"
             2) "index"
             3) "spec"
             4) 1) "index"
                2) (integer) 2
          7) "find_keys"
          8) 1) "type"
             2) "keynum"
             3) "spec"
             4) 1) "keynumidx"
                2) (integer) 0
                3) "firstkey"
                4) (integer) 1
                5) "keystep"
                6) (integer) 1
   10) (empty array)
```

--------------------------------

### Start Valkey server and observe module loading log output

Source: https://valkey.io/blog/modules-101

Run src/valkey-server valkey.conf to start the server. The log output confirms that both modules are loaded successfully.

```plaintext
src/valkey-server valkey.conf
```

```plaintext
Module 'module1' loaded from UPDATE_PATH_TO_VALKEY/src/modules/module1.so
...
Module 'module2' loaded from UPDATE_PATH_TO_MODULE2/target/debug/libmodule2.dylib
```

--------------------------------

### APPEND basic usage example

Source: https://valkey.io/commands/append

Shows the behavior of APPEND on a non-existing key and then appending to an existing string. The command returns the new string length after each append. The example also demonstrates that GET retrieves the concatenated result.

```redis
127.0.0.1:6379> EXISTS mykey
(integer) 0
127.0.0.1:6379> APPEND mykey "Hello"
(integer) 5
127.0.0.1:6379> APPEND mykey " World"
(integer) 11
127.0.0.1:6379> GET mykey
"Hello World"
```

--------------------------------

### XLEN command to get stream length

Source: https://valkey.io/topics/streams-intro

Returns the number of entries in the stream 'race:france'. In this example, the output is 4.

```redis
127.0.0.1:6379> XLEN race:france
(integer) 4
```

--------------------------------

### Run valkey-server with default configuration

Source: https://valkey.io/topics/server

Starts the Valkey server using default settings.

```bash
valkey-server
```

--------------------------------

### CLUSTERSCAN iteration example

Source: https://valkey.io/commands/clusterscan

Demonstrates starting a scan with cursor 0 and continuing through subsequent slots using the returned cursor values.

```text
127.0.0.1:6379> CLUSTERSCAN 0
1) "0-{06S}-0"
2) (empty list or set)
127.0.0.1:6379> CLUSTERSCAN 0-{06S}-0
1) "0B3a21-{06S}-96"
2) 1) "key:1"
   2) "key:2"
   3) "key:3"
127.0.0.1:6379> CLUSTERSCAN 0B3a21-{06S}-96
1) "0-{Qi}-0"
2) 1) "key:4"
```

--------------------------------

### Start valkey-server with mixed configuration sources

Source: https://valkey.io/topics/server

Combines a configuration file, command-line overrides, and stdin input.

```bash
valkey-server /etc/myvalkey.conf --loglevel verbose -
```

--------------------------------

### Run a valkey-bundle instance

Source: https://valkey.io/blog/valkey-bundle-one-stop-shop-for-low-latency-modern-applications

Start a container instance named 'my-valkey-bundle' mapping port 6379 to the host.

```bash
docker run --name my-valkey-bundle -p 6379:6379 -d valkey/valkey-bundle
```

--------------------------------

### Setup Index and Data for Tag Queries

Source: https://valkey.io/topics/search-query

Initial index declaration and data set used for subsequent tag query examples.

```bash
valkey-cli FT.CREATE index SCHEMA color TAG
valkey-cli HSET key1 color blue
valkey-cli HSET key2 color black
valkey-cli HSET key3 color green
valkey-cli HSET key4 color beige
valkey-cli HSET key5 color "beige,green"
valkey-cli HSET key6 color "hello world, green is my heart"
```

--------------------------------

### XINFO STREAM FULL Reply

Source: https://valkey.io/commands/xinfo-stream

Example showing the setup of a stream with a consumer group and the subsequent output of XINFO STREAM with the FULL modifier.

```text
> XADD mystream * foo bar
"1638125133432-0"
> XADD mystream * foo bar2
"1638125141232-0"
> XGROUP CREATE mystream mygroup 0-0
OK
> XREADGROUP GROUP mygroup Alice COUNT 1 STREAMS mystream >
1) 1) "mystream"
   2) 1) 1) "1638125133432-0"
         2) 1) "foo"
            2) "bar"
> XINFO STREAM mystream FULL
 1) "length"
 2) (integer) 2
 3) "radix-tree-keys"
 4) (integer) 1
 5) "radix-tree-nodes"
 6) (integer) 2
 7) "last-generated-id"
 8) "1638125141232-0"
 9) "max-deleted-entry-id"
10) "0-0"
11) "entries-added"
12) (integer) 2
13) "entries"
14) 1) 1) "1638125133432-0"
       2) 1) "foo"
          2) "bar"
    2) 1) "1638125141232-0"
       2) 1) "foo"
          2) "bar2"
15) "groups"
16) 1)  1) "name"
        2) "mygroup"
        3) "last-delivered-id"
        4) "1638125133432-0"
        5) "entries-read"
        6) (integer) 1
        7) "lag"
        8) (integer) 1
        9) "pel-count"
       10) (integer) 1
       11) "pending"
       12) 1) 1) "1638125133432-0"
              2) "Alice"
              3) (integer) 1638125153423
              4) (integer) 1
       13) "consumers"
       14) 1) 1) "name"
              2) "Alice"
              3) "seen-time"
              4) (integer) 1638125133422
              5) "active-time"
              6) (integer) 1638125133432
              7) "pel-count"
              8) (integer) 1
              9) "pending"
              10) 1) 1) "1638125133432-0"
                     2) (integer) 1638125133432
                     3) (integer) 1
```

--------------------------------

### Start a Valkey instance

Source: https://valkey.io/topics/cluster-tutorial

Start a Valkey instance in a specific directory using its local configuration file.

```bash
cd 7000
valkey-server ./valkey.conf
```

--------------------------------

### Define ACL user with selectors

Source: https://valkey.io/commands/acl-setuser

Sets a user with root permissions for GET on all keys and a selector granting SET access on keys starting with app1.

```text
ACL SETUSER virginia on +GET allkeys (+SET ~app1*)
```

--------------------------------

### Run Valkey server using configuration file

Source: https://valkey.io/topics/RDMA

Load the RDMA module by adding the configuration line to valkey.conf and starting the server with the file.

```bash
./src/valkey-server valkey.conf
```

--------------------------------

### Start valkey-server with file and command line overrides

Source: https://valkey.io/topics/server

Uses a configuration file while overriding specific settings via command-line arguments.

```bash
valkey-server /etc/myvalkey.conf --loglevel verbose
```

--------------------------------

### CLUSTER SHARDS slots field representation

Source: https://valkey.io/commands/cluster-shards

Example representation of the 'slots' field in the CLUSTER SHARDS output, showing inclusive start and end slot ranges.

```text
1) 1) "slots"
   2) 1) (integer) 1
      2) (integer) 3
      3) (integer) 5
      4) (integer) 5
      5) (integer) 7
      6) (integer) 9
```

--------------------------------

### Sample valkey.conf Configuration File

Source: https://valkey.io/topics/valkey-bundle

A comprehensive configuration file example including settings for Valkey core, JSON, Bloom, Search, and LDAP modules.

```text
# Valkey settings
port 6379
bind 127.0.0.1
protected-mode yes
requirepass "strong_password"

######################## JSON Module ########################
# Maximum document size (in bytes, 0 = unlimited)
json.max-document-size 1048576

# Maximum nesting depth for JSON documents
json.max-path-limit 32

######################## Bloom Module ########################
# Default initial capacity for new bloom filters
bf.bloom-capacity 100000

# Default false positive rate
bf.bloom-fp-rate 0.01

# Memory usage limit per bloom filter (in bytes)
bf.bloom-memory-usage-limit 134217728  # 128MB

# Default expansion rate for scaling filters
bf.bloom-expansion 2

######################## Search Module ########################
# Thread configuration for search operations
search.reader-threads 8
search.writer-threads 4

# HNSW graph configuration
search.hnsw-block-size 10000

# Enable cluster mode
search.use-coordinator no

# Log level (debug, verbose, notice, warning)
search.log-level notice

######################## LDAP Module ########################
# LDAP server configuration
ldap.servers "ldap://primary:389,ldap://backup:389"
ldap.auth_mode "search+bind"

# TLS configuration
ldap.use_starttls yes
ldap.tls_ca_cert_path "/path/to/ca.crt"
ldap.tls_cert_path "/path/to/client.crt"
ldap.tls_key_path "/path/to/client.key"

# Search+bind mode settings
ldap.search_base "ou=users,dc=valkey,dc=io"
ldap.search_filter "objectClass=person"
ldap.search_attribute "uid"
ldap.search_bind_dn "cn=readonly,dc=valkey,dc=io"
ldap.search_bind_passwd "readonly_password"

# Performance tuning
ldap.connection_pool_size 5
ldap.timeout_connection 5
ldap.timeout_ldap_operation 3
ldap.failure_detector_interval 1

######################## Common Settings ########################
# Memory and performance
maxmemory 4gb
maxmemory-policy allkeys-lru

# Persistence
save 900 1
save 300 10
save 60 10000

# Logging
loglevel notice
logfile "/var/log/valkey/valkey.log"
```

--------------------------------

### SCAN full iteration example

Source: https://valkey.io/commands/scan

Demonstrates a full iteration process starting with a cursor of 0 and continuing until the server returns 0, indicating the collection has been fully explored.

```text
127.0.0.1:6379> scan 0
1) "17"
2)  1) "key:12"
    2) "key:8"
    3) "key:4"
    4) "key:14"
    5) "key:16"
    6) "key:17"
    7) "key:15"
    8) "key:10"
    9) "key:3"
   10) "key:7"
   11) "key:1"
127.0.0.1:6379> scan 17
1) "0"
2) 1) "key:5"
   2) "key:18"
   3) "key:0"
   4) "key:2"
   5) "key:19"
   6) "key:13"
   7) "key:6"
   8) "key:9"
   9) "key:11"
```

--------------------------------

### COMMAND GETKEYS usage examples

Source: https://valkey.io/commands/command-getkeys

Examples demonstrating how to extract keys from various Valkey commands like MSET, EVAL, and SORT.

```text
127.0.0.1:6379> COMMAND GETKEYS MSET a b c d e f
1) "a"
2) "c"
3) "e"
127.0.0.1:6379> COMMAND GETKEYS EVAL "not consulted" 3 key1 key2 key3 arg1 arg2 arg3 argN
1) "key1"
2) "key2"
3) "key3"
127.0.0.1:6379> COMMAND GETKEYS SORT mylist ALPHA STORE outlist
1) "mylist"
2) "outlist"
```

--------------------------------

### LPOS command example with COUNT and RANK options

Source: https://valkey.io/commands/lpos

Shows how to use LPOS to find the position of an element in a list. The example first pushes elements to 'mylist' with RPUSH, then finds the first occurrence of 3, and finally uses COUNT 0 and RANK 2 to return all occurrences starting from the second one.

```redis-cli
127.0.0.1:6379> RPUSH mylist a b c d 1 2 3 4 3 3 3
(integer) 11
127.0.0.1:6379> LPOS mylist 3
(integer) 6
127.0.0.1:6379> LPOS mylist 3 COUNT 0 RANK 2
1) (integer) 8
2) (integer) 9
3) (integer) 10
```

--------------------------------

### Initialize a new Swift project

Source: https://valkey.io/blog/valkey-swift

Commands to create a new directory and initialize a Swift executable package.

```bash
$ mkdir try-valkey-swift
$ cd try-valkey-swift
$ swift package init --type executable
Creating executable package: try-valkey-swift
Creating Package.swift
Creating .gitignore
Creating Sources/
Creating Sources/main.swift
```

--------------------------------

### Define user with password and key/command permissions using ACL SETUSER

Source: https://valkey.io/topics/acl

Enables the user 'alice', sets a password 'p1pp0', allows access to keys starting with 'cached:', and permits only the GET command. This makes the user active and able to perform limited operations.

```valkey-cli
> ACL SETUSER alice on >p1pp0 ~cached:* +get
OK
```

--------------------------------

### Launch Valkey server

Source: https://valkey.io/blog/unlock-one-million-rps-part2

Start the Valkey server with minimal configurations, including 9 I/O threads and disabled RDB saving.

```bash
./valkey-server --io-threads 9 --save --protected-mode no
```

--------------------------------

### XRANGE with COUNT 1 to get first matching entry

Source: https://valkey.io/commands/xrange

Uses the COUNT option to return only one entry. If the specified start ID exists, it is returned; otherwise the next entry is returned. This is useful for queries like 'give me the entry greater or equal to the following'.

```redis
> XRANGE somestream 1526985054069-0 + COUNT 1
1) 1) 1526985054069-0
   2) 1) "duration"
      2) "72"
      3) "event-id"
      4) "9"
      5) "user-id"
      6) "839248"
```

--------------------------------

### SENTINEL CONFIG GET

Source: https://valkey.io/topics/sentinel

Get the current value of a global Sentinel configuration parameter. The specified name may be a wildcard, similar to the Valkey CONFIG GET command.

```APIDOC
## SENTINEL CONFIG GET <name>

### Description
Get the current value of a global Sentinel configuration parameter. The specified name may be a wildcard, similar to the Valkey CONFIG GET command.

### Method
SENTINEL

### Endpoint
SENTINEL CONFIG GET <name>

### Parameters
#### Path Parameters
- **name** (string) - Required - The configuration parameter name, may include wildcards.

### Response
#### Success Response
Returns the current value of the specified configuration parameter.

```

--------------------------------

### Example Implementation of String Configuration

Source: https://valkey.io/topics/modules-api-ref

An example showing how to define getter and setter callbacks and register a string configuration using ValkeyModule_RegisterStringConfig.

```c
ValkeyModuleString *strval;
int adjustable = 1;
ValkeyModuleString *getStringConfigCommand(const char *name, void *privdata) {
    return strval;
}

int setStringConfigCommand(const char *name, ValkeyModuleString *new, void *privdata, ValkeyModuleString **err) {
   if (adjustable) {
       ValkeyModule_Free(strval);
       ValkeyModule_RetainString(NULL, new);
       strval = new;
       return VALKEYMODULE_OK;
   }
   *err = ValkeyModule_CreateString(NULL, "Not adjustable.", 15);
   return VALKEYMODULE_ERR;
}
...
ValkeyModule_RegisterStringConfig(ctx, "string", NULL, VALKEYMODULE_CONFIG_DEFAULT, getStringConfigCommand,

setStringConfigCommand, NULL, NULL);
```

--------------------------------

### Start Valkey container

Source: https://valkey.io/topics/migration

Launch the Valkey container with the host directory mounted. Ensure AOF is disabled for the initial import.

```bash
docker run -d --name valkey-container-name -v <path/on/host>:<path/in/Valkey/container> image-name
```

--------------------------------

### Install phpredis

Source: https://valkey.io/clients

Use this command to install the phpredis PHP extension.

```bash
pecl install redis
```

--------------------------------

### GETBIT usage example

Source: https://valkey.io/commands/getbit

Demonstrates setting a bit with SETBIT and retrieving it with GETBIT, including cases for offsets within and beyond the string length.

```text
127.0.0.1:6379> SETBIT mykey 7 1
(integer) 0
127.0.0.1:6379> GETBIT mykey 0
(integer) 0
127.0.0.1:6379> GETBIT mykey 7
(integer) 1
127.0.0.1:6379> GETBIT mykey 100
(integer) 0
```

--------------------------------

### SENTINEL CONFIG GET <name>

Source: https://valkey.io/topics/sentinel

Gets the current value of a global Sentinel configuration parameter. The name may include wildcards, similar to the Valkey CONFIG GET command.

```APIDOC
## SENTINEL CONFIG GET <name>

### Description
Gets the current value of a global Sentinel configuration parameter. The name may include wildcards, similar to the Valkey CONFIG GET command.

### Method
SENTINEL CONFIG GET

### Parameters
- **name** (string) - Required - The name of the global configuration parameter, may include wildcards.

### Request Example
SENTINEL CONFIG GET resolve-hostnames

### Response
No specific response format is documented.
```

--------------------------------

### Connect to a standalone Valkey server

Source: https://valkey.io/blog/2025-03-4-go-client-in-public-preview

This example demonstrates how to configure a client for a standalone Valkey server running on localhost:6379, perform a ping, and execute basic set/get operations.

```go
package main

import (
    "fmt"
    "github.com/valkey-io/valkey-glide/go/api"
)

func main() {
    // Connect to a standalone Valkey server
    config := api.NewGlideClientConfiguration().
        WithAddress(&api.NodeAddress{Host: "localhost", Port: 6379})
    
    client, err := api.NewGlideClient(config)
    if err != nil {
        fmt.Println("Error:", err)
        return
    }
    defer client.Close()
    
    // Test the connection
    result, err := client.Ping()
    if err != nil {
        fmt.Println("Error:", err)
        return
    }
    fmt.Println(result) // PONG
    
    // Store and retrieve a value
    client.Set("hello", "valkey")
    value, _ := client.Get("hello")
    fmt.Println(value) // valkey
}
```

--------------------------------

### BITFIELD_RO key [GET encoding offset ...]

Source: https://valkey.io/commands/bitfield_ro

Read-only variant of BITFIELD that only accepts GET subcommands. It can be safely used on read-only replicas and returns an array of results for each GET subcommand.

```APIDOC
## BITFIELD_RO key [GET encoding offset ...]

### Description
Read-only variant of the BITFIELD command. It is similar to the original BITFIELD but only accepts GET subcommand and can safely be used in read-only replicas.

### Method
BITFIELD_RO

### Endpoint
BITFIELD_RO key [GET encoding offset ...]

### Parameters
#### Key
- **key** (string) - Required - The key of the bitmap.

#### Subcommands
- **GET** (subcommand) - Required - Specifies a GET operation with encoding and offset.
  - **encoding** (string) - Required - The bit encoding (e.g., i8, u8).
  - **offset** (integer) - Required - The bit offset.

### Request Example
BITFIELD_RO hello GET i8 16

### Response
#### Success Response (Array reply)
Each entry being the corresponding result of the sub-command given at the same position.

#### Response Example
[1, 2, 3]

```

--------------------------------

### GETDEL Usage Example

Source: https://valkey.io/commands/getdel

Demonstrates setting a key, retrieving and deleting it with GETDEL, and verifying the deletion.

```text
127.0.0.1:6379> SET mykey "Hello"
OK
127.0.0.1:6379> GETDEL mykey
"Hello"
127.0.0.1:6379> GET mykey
(nil)
```
Tokens:
Raw