Download documentation

Choose the products and versions you want. Everything arrives as one .tar.gz, with a directory per product.

Format

This page

	Products	Version
	Develop with Redis Clients, data types, programmability, and Redis for AI. RedisVL is listed separately.
	Libraries and tools Client libraries, observability, and cloud integrations. Redis Data Integration is listed separately.
	RedisVL
	Redis Software
	Redis Cloud
	Redis for Kubernetes
	Redis Open Source
	Redis Iris context engine
	Redis Feature Form
	Redis Insight
	Redis Data Integration
	Glossary
	Command reference

LPUSHX

Syntax text Syntax diagram API methods

LPUSHX key element [element ...]

Client:

lpushx(
    name: KeyT,
    *values: FieldT
) → Union[Awaitable[int], int]

lpushx(
    key: byte[],
    strings: byte[]...  // the strings to push
) → long  // The length of the list after the push operation

lpushx(
    key: String,
    strings: String...  // the strings to push
) → long  // The length of the list after the push operation

lpushx(
    key: String,
    strings: String...  // the strings to push
) → long  // The length of the list after the push operation

lpushx(
    key: K,  // the key.
    values: V...  // the values.
) → Long  // Long integer-reply the length of the list after the push operation.

lpushx(
    key: K,  // the key.
    values: V...  // the values.
) → RedisFuture<Long>  // Long integer-reply the length of the list after the push operation.

lpushx(
    key: K,  // the key.
    values: V...  // the values.
) → Mono<Long>  // Long integer-reply the length of the list after the push operation.

LPushX(
    ctx: context.Context,
    key: string,
    values: ...interface{}
) → *IntCmd

lpushx(
    $key: string,
    $values: array
) → int

lpush_exists(
    key: K,
    value: V
) → (usize)

lpush_exists(
    key: K,
    value: V
) → (usize)

Available since:: Redis Open Source 2.2.0
Time complexity:: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments.
ACL categories:: @write, @list, @fast,
Compatibility:: Redis Software and Redis Cloud compatibility

Inserts specified values at the head of the list stored at key, only if key already exists and holds a list. In contrary to LPUSH, no operation will be performed when key does not yet exist.

Required arguments

key

The name of the key that holds the list.

element [element ...]

One or more values to prepend to the list, only if it already exists.

Examples

redis> LPUSH mylist "World"
(integer) 1
redis> LPUSHX mylist "Hello"
(integer) 2
redis> LPUSHX myotherlist "Hello"
(integer) 0
redis> LRANGE mylist 0 -1
1) "Hello"
2) "World"
redis> LRANGE myotherlist 0 -1
(empty array)

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Standard ✅ Active-Active	✅ Standard ✅ Active-Active

Return information

RESP2 RESP3

Integer reply: the length of the list after the push operation.

History

Starting with Redis version 4.0.0: Accepts multiple element arguments.