object-encoding.3valkey - Man Page

OBJECT ENCODING key

Returns the internal encoding for the Valkey object stored at <key>

Valkey objects can be encoded in different ways:

• Strings can be encoded as:

  • raw, normal string encoding.
  • int, strings representing integers in a 64-bit signed interval, encoded in this way to save space.
  • embstr, an embedded string, which is an object where the internal simple dynamic string, sds, is an unmodifiable string allocated in the same chuck as the object itself. embstr can be strings with lengths up to the hardcoded limit of OBJ_ENCODING_EMBSTR_SIZE_LIMIT or 44 bytes.

• Lists can be encoded as:

  • linkedlist, simple list encoding. No longer used, an old list encoding.
  • listpack, a space-efficient encoding used for small lists.
  • quicklist, encoded as linked list of ziplists or listpacks.

• Sets can be encoded as:

  • hashtable, normal set encoding.
  • intset, a special encoding used for small sets composed solely of integers.
  • listpack, a space-efficient encoding used for small sets.

• Hashes can be encoded as:

  • zipmap, no longer used, an old hash encoding.
  • hashtable, normal hash encoding.
  • listpack, a space-efficient encoding used for small hashes.

• Sorted Sets can be encoded as:

  • skiplist, normal sorted set encoding.
  • listpack, a space-efficient encoding used for small sorted sets.

• Streams can be encoded as:

  • stream, encoded as a radix tree of listpacks.

All the specially encoded types are automatically converted to the general type once you perform an operation that makes it impossible for Valkey to retain the space saving encoding.

O(1)

@keyspace @read @slow

• Available since: 2.2.3

copy(3valkey), del(3valkey), dump(3valkey), exists(3valkey), expire(3valkey), expireat(3valkey), expiretime(3valkey), keys(3valkey), migrate(3valkey), move(3valkey), object(3valkey), object-freq(3valkey), object-help(3valkey), object-idletime(3valkey), object-refcount(3valkey), persist(3valkey), pexpire(3valkey), pexpireat(3valkey), pexpiretime(3valkey), pttl(3valkey), randomkey(3valkey), rename(3valkey), renamenx(3valkey), restore(3valkey), scan(3valkey), sort(3valkey), sort_ro(3valkey), touch(3valkey), ttl(3valkey), type(3valkey), unlink(3valkey), wait(3valkey), waitaof(3valkey)