Skip to content
HotKVDocs

Ask the HotKV docs

Answers come only from these docs and can be wrong; check the linked pages before you rely on them.

TENANT.INFO

Last updated 
TENANT.INFO id
Group
Tenancy
Complexity
O(1)
Arity
2 (exactly, counting the command name)
Flags
admin, read-only, fast
HotKV Cloud
Scale
On-Premise
requires the multi-tenancy license feature

TENANT.INFO describes one tenant: its ID, display name and state, and the usage figures this node keeps for it. For the quota values as well, use TENANT.STATS.

Return value

Section titled “Return value”

Nil (RESP2) or null (RESP3) when the tenant does not exist. Otherwise a flat array of field and value pairs, in RESP2 and RESP3:

Field Type Meaning
id Bulk string Tenant ID
name Bulk string Display name
state Bulk string active, or suspended after TENANT.SUSPEND
memory_bytes Integer Usage figure kept by this node
key_count Integer Usage figure kept by this node
active_connections Integer Usage figure kept by this node
total_commands Integer Usage figure kept by this node

Usage figures are per node. They are not updated by client traffic, so they read 0.

Without a license that includes multi-tenancy, the reply is NOLICENSE multi-tenancy requires a HotKV license. Contact sales@hotkv.com.

Examples

Section titled “Examples”
127.0.0.1:6379> TENANT.INFO acme
 1) "id"
 2) "acme"
 3) "name"
 4) "Acme Corp"
 5) "state"
 6) "active"
 7) "memory_bytes"
 8) (integer) 0
 9) "key_count"
10) (integer) 0
11) "active_connections"
12) (integer) 0
13) "total_commands"
14) (integer) 0
127.0.0.1:6379> TENANT.INFO nosuch
(nil)

Compatibility

Section titled “Compatibility”

HotKV-only command.

See also

Section titled “See also”

TENANT.STATS, TENANT.LIST