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.

VSIM.INFO

Last updated 
VSIM.INFO [index]
Group
Vector search
Complexity
O(1), or O(N) for the list of indexes
Arity
-1 (at least 1 words, counting the command name)
Flags
read-only, fast
Keys
first 1, last 1, step 1
HotKV Cloud
All plans
On-Premise
no license needed

Without an argument, VSIM.INFO lists the names of all vector indexes on the node. With an index name, it returns that index’s settings and counters.

Fields

Section titled “Fields”
Field Meaning
name The index name.
dimensions Values per vector.
metric cosine, l2 or ip.
vectors Vectors currently stored.
M, ef_construction, ef_search The tuning options the index was created with (see VSIM.CREATEINDEX).
deleted_vectors, free_slots, total_slots Diagnostic counters. Do not rely on them in your own tooling.
memory_bytes Estimated memory used by the index.

Return value

Section titled “Return value”
Case RESP2 RESP3
No argument Array of index names Same
With an index Flat array of field names (bulk strings) and values Same flat array

Error replies: ERR index 'name' not found.

Examples

Section titled “Examples”
127.0.0.1:6379> VSIM.CREATEINDEX points 3 METRIC L2
OK
127.0.0.1:6379> VSIM.INFO
1) "points"
127.0.0.1:6379> VSIM.INFO nosuchindex
(error) ERR index 'nosuchindex' not found

Compatibility

Section titled “Compatibility”

HotKV-only command.

See also

Section titled “See also”

VSIM.CREATEINDEX, VSIM.DROPINDEX