redis commands common ls-use-sql

LS   (list) - old version

Apply for Redis Developer Course	Redis Regular Inspection / Technical Support	Redis Enterprise Server

---

List keys - old (use-sql) version reference page (currently unused)

Usage is ls or ls pattern.
ls lists all keys.
This command is available on Enterprise servers when redis.conf use-sql yes is set.

You can use a glob-style pattern.

• * : Matches any characters: h*llo -> hllo, heeeello, etc
• ? : Matches one character: h?llo -> hallo, hello, hxllo, etc
• [alphabet] : Matches a character inside the brackets: h[ae]llo -> hallo, hello
  
• [^e] : Matches any character except those in the brackets: h[^e]llo -> hallo, hbllo, ... but hello is excluded.
  
• [a-c] : Matches a character in the range: h[a-c]llo -> hallo, hbllo, hcllo
• \ : Prefix special characters (*?[^]) with \ to use them literally.

Specify a data type

You can specify a data type to list only those keys. Allowed data types are string, list, set, zset, hash, stream.

• When a data type is specified, keys are looked up in the Sorted Set managed per data type, not in the full key set, so it is fast and does not burden the server.
  B1 B2 B3 C1 C2 C3 D1 D2 D3
                    \__C*__/
• When a data type is specified, results are sorted even without the sort option.
• Using "ls user* string" looks up keys starting with user directly.
• If you specify multiple data types, a sorted key list is returned per type.

Specify options

• TYPE: Shows the key data type.
• ENCODING: Shows the internal encoding of the key.
• VALUE or VAL: Shows the value for String keys. This option applies only to String.
• STRLEN: Shows the string length for String keys. This option applies only to String.
• LEN: Shows the length (member count) of the key. Same as running llen for List, scard for Set, zcard for ZSet, hlen for Hash, and xlen for Stream. For String, 1 is shown.
• MEMORY or MEM: Shows memory usage. Same as running memory usage key.
• TTL: Shows expire time in seconds. If expire is not set, -1 is shown.
• PTTL: Shows expire time in milliseconds. If expire is not set, -1 is shown.
• IDLETIME: Shows seconds since the key was last referenced. You can check whether the key was used recently and how long it has been idle.
• SLOT: Shows the key slot. Shown for Cluster and also for Standalone.
• TIME: Shows the key update_mstime (creation time or last modification time).
• EXPIRE_KEYS: Lists keys that have expire time set on members.   Combined with TTL, it shows the largest expire time set on members.
• DEFAULT or DF: Applies the type, len, and table options.

• You can specify a data type and options together.

Specify sort options

• SORT/ASC/DESC: Sorts the results.

Specify COUNT/TOP options

• COUNT integer: Limits the number of keys returned. Can reduce lookup time.
• TOP integer: Limits the number of keys shown after sorting.

Specify the TABLE option

• table: Shows results in table form.

Syntax

LS   [pattern]   [string|list|set|zset|hash|stream]
  [type|encoding|value|strlen|len|memory|ttl|pttl|idletime|slot|time|expire_keys|default]
  [table]
  [sort|asc|desc]
  [count <integer>] [top <integer>]

• Available since Enterprise version 6.1.0.
• Time complexity is O(log(N)+M) when a data type is specified. N is the number of keys of that data type, and M is the number of keys returned.
  When not specified: O(N). N is the number of all keys in the database, not the number of returned keys.

Related commands

SCAN, DBSIZE

---