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.

LICENSE.CHECK

Last updated 
LICENSE.CHECK feature
Group
License
Complexity
O(1)
Arity
2 (exactly, counting the command name)
Flags
admin, fast
HotKV Cloud
All plans
On-Premise
no license needed

LICENSE.CHECK answers 1 if the license in force enables the feature and 0 if not (also 0 when no license is in force). Scripts and health checks can use it before they rely on an enterprise feature.

The command takes its own short feature names, which differ from the names in LICENSE.INFO and the NOLICENSE errors. Names are not case sensitive.

LICENSE.CHECK name Feature (LICENSE.INFO name)
replication replication
encryption encryption-at-rest
audit audit-log
multitenancy multi-tenancy
all Every feature at once

The other licensed modules are checked the same way. LICENSE.INFO shows which features your license enables.

Return value

Section titled “Return value”
Case RESP2 RESP3
Known name Integer 1 or 0 Integer
Unknown name Error ERR unknown feature name Same error

Examples

Section titled “Examples”
127.0.0.1:6379> LICENSE.CHECK replication
(integer) 1
127.0.0.1:6379> LICENSE.CHECK audit
(integer) 0
127.0.0.1:6379> LICENSE.CHECK audit-log
(error) ERR unknown feature name

Compatibility

Section titled “Compatibility”

HotKV-only command.

See also

Section titled “See also”

LICENSE.INFO, LICENSE.SET