kv¶

vb kv SUBCOMMAND [OPTIONS]

Description¶

Run various subcommands to use distributed key-value database.

Options¶

-s, --server¶: Use key-value database server, instead of settings

-u, --username¶: Basic Authorization username, instead of settings

-p, --password¶: Basic Authorization password, instead of settings

Subcommands¶

vb kv get¶

vb kv get KEY-NAME [RANGE_END] [OPTIONS]

Description¶

Gets the key or a range of keys

vb kv put¶

vb kv put KEY-NAME VALUE [OPTIONS]

Description¶

Puts the given key into the store. A put request increments the revision of the key-value store and generates one event in the event history.

Options¶

--lease="0"¶: lease ID (in hexadecimal) to attach to the key

vb kv putfile¶

vb kv putfile KEY-NAME PATH [OPTIONS]

Description¶

Puts a file content with given key into the store, If a PATH is named - then take its content from standard input.

vb kv del¶

vb kv del KEY-NAME [RANGE_END] [OPTIONS]

Description¶

Removes the given range from the key-value store. A delete request increments the revision of the key-value store and generates a delete event in the event history for every deleted key.

vb kv txn¶

vb kv txn [OPTIONS]

Description¶

Txn processes multiple requests in a single transaction. A txn request increments the revision of the key-value store and generates events with the same revision for every completed request. It is not allowed to modify the same key several times within one txn.

vb kv lock¶

vb kv lock LOCKNAME [OPTIONS]

Description¶

Acquires a named lock.

Options¶

--ttl=10¶: timeout for session

vb kv unlock¶

vb kv unlock [Token]

Description¶

unlock a named lock

vb kv lease grant¶

vb kv lease grant TTL [OPTIONS]

Description¶

LeaseGrant creates a lease which expires if the server does not receive a keepAlive within a given time to live period. All keys attached to the lease will be expired and deleted if the lease expires. Each expired key generates a delete event in the event history.

Options¶

--ID=0¶: Assigned Lease ID

vb kv lease revoke¶

vb kv lease revoke

Description¶

LeaseRevoke revokes a lease. All keys attached to the lease will expire and be deleted.

vb kv lease keepalive¶

vb kv lease keepalive

Description¶

LeaseKeepAlive keeps the lease alive by streaming keep alive requests from the client to the server and streaming keep alive responses from the server to the client.

vb kv lease timetolive¶

vb kv lease timetolive

Description¶

LeaseTimeToLive retrieves lease information.

Options¶

--keys=false¶: keys is true to query all the keys attached to this lease.

vb kv lease¶

vb kv lease Leases

Description¶

LeaseLeases lists all existing leases.

vb kv auth enable¶

vb kv auth enable

Description¶

Enables authentication for the key-value store.

vb kv auth disable¶

vb kv auth disable

Description¶

Disables authentication for the key-value store.

vb kv auth status¶

vb kv auth status

Description¶

Retrieves the current authentication status of the key-value store.

vb kv auth user add¶

vb kv auth user add USERNAME PASSWORD

Description¶

Adds a new user to the key-value store.

vb kv auth user get¶

vb kv auth user get USERNAME

Description¶

Retrieves the details of an existing user.

vb kv auth user delete¶

vb kv auth user delete USERNAME

Description¶

Deletes a user from the key-value store.

vb kv auth user list¶

vb kv auth user list

Description¶

Lists all users in the key-value store system.

vb kv auth user passwd¶

vb kv auth user passwd USERNAME NEW_PASSWORD

Description¶

Changes the password of an existing user.

vb kv auth user grant¶

vb kv auth user grant USERNAME ROLENAME

Description¶

Grants a role to a user.

vb kv auth user revoke¶

vb kv auth user revoke USERNAME ROLENAME

Description¶

Revokes a role from a user.

vb kv auth role add¶

vb kv auth role add ROLE_NAME

Description¶

Adds a new role to the key-value store system.

vb kv auth role get¶

vb kv auth role get ROLE_NAME

Description¶

Retrieves the details of an existing role.

vb kv auth role delete¶

vb kv auth role delete ROLE_NAME

Description¶

Deletes a role from the key-value store system.

vb kv auth role list¶

vb kv auth role list

Description¶

Lists all roles in the key-value store system.

vb kv auth role grant-permission¶

vb kv auth role grant-permission ROLE_NAME PERMISSION_TYPE KEY RANGE_END

Description¶

Grants a permission to a role. RANGE_END is a option PERMISSION_TYPE: read,write and readwrite

vb kv auth role revoke-permission¶

vb kv auth role revoke-permission ROLE_NAME KEY RANGE_END

Description¶

Revokes a permission from a role. RANGE_END is a option

vb kv auth authenticate¶

vb kv auth authenticate USERNAME PASSWORD

Description¶

Authenticates a user by username and password.

vb kv version¶

vb kv version

Description¶

Print key-value server database version

Examples¶

Check auth status, then disable and re-check

$ vb kv auth status
Authentication status: true
AuthRevision: 1194

$ vb kv auth disable
Unable to verify SSL cert from kvdb.softbridge.com
  subject:   CN = softbridge.com
  issuer:    C = US, O = Let's Encrypt, CN = E7
  notBefore: 2026-02-24 03:42:29 UTC
  notAfter:  2026-05-25 03:42:28 UTC
  sha256:    b4be4dd33a5f37550eae441bbaf7db042c7dd958ab3c6964077dafcc170a9355
accept this cert and continue (y/N/fingerprint)? SSL cert declined

KVDB Error: Error Code [1] - Unknown error.
0�F

$ vb kv auth status
Authentication status: false
AuthRevision: 1194

Enable auth, then authenticate a user

$ vb kv auth enable
Unable to verify SSL cert from kvdb.softbridge.com
  subject:   CN = softbridge.com
  issuer:    C = US, O = Let's Encrypt, CN = E7
  notBefore: 2026-02-24 03:42:29 UTC
  notAfter:  2026-05-25 03:42:28 UTC
  sha256:    b4be4dd33a5f37550eae441bbaf7db042c7dd958ab3c6964077dafcc170a9355
accept this cert and continue (y/N/fingerprint)? SSL cert declined

KVDB Error: Error Code [1] - Unknown error.
�4

$ vb kv auth status
Authentication status: true
AuthRevision: 1194

$ vb kv auth authenticate dev devpass
Unable to verify SSL cert from kvdb.softbridge.com
  subject:   CN = softbridge.com
  issuer:    C = US, O = Let's Encrypt, CN = E7
  notBefore: 2026-02-24 03:42:29 UTC
  notAfter:  2026-05-25 03:42:28 UTC
  sha256:    b4be4dd33a5f37550eae441bbaf7db042c7dd958ab3c6964077dafcc170a9355
accept this cert and continue (y/N/fingerprint)? SSL cert declined
Authentication failed

Basic read/write

$ vb kv put app/config/theme light
Unable to verify SSL cert from kvdb.softbridge.com
  subject:   CN = softbridge.com
  issuer:    C = US, O = Let's Encrypt, CN = E7
  notBefore: 2026-02-24 03:42:29 UTC
  notAfter:  2026-05-25 03:42:28 UTC
  sha256:    b4be4dd33a5f37550eae441bbaf7db042c7dd958ab3c6964077dafcc170a9355
accept this cert and continue (y/N/fingerprint)? SSL cert declined

KVDB Error: Error Code [1] - Unknown error.
���

$ vb kv get app/config/theme
Unable to verify SSL cert from kvdb.softbridge.com
  subject:   CN = softbridge.com
  issuer:    C = US, O = Let's Encrypt, CN = E7
  notBefore: 2026-02-24 03:42:29 UTC
  notAfter:  2026-05-25 03:42:28 UTC
  sha256:    b4be4dd33a5f37550eae441bbaf7db042c7dd958ab3c6964077dafcc170a9355
accept this cert and continue (y/N/fingerprint)? SSL cert declined

KVDB Error: Error Code [1] - Unknown error.
0

$ vb kv putfile app/docs/readme payload.txt
Unable to verify SSL cert from kvdb.softbridge.com
  subject:   CN = softbridge.com
  issuer:    C = US, O = Let's Encrypt, CN = E7
  notBefore: 2026-02-24 03:42:29 UTC
  notAfter:  2026-05-25 03:42:28 UTC
  sha256:    b4be4dd33a5f37550eae441bbaf7db042c7dd958ab3c6964077dafcc170a9355
accept this cert and continue (y/N/fingerprint)? SSL cert declined

KVDB Error: Error Code [1] - Unknown error.
�D�

$ vb kv del app/config/theme
Unable to verify SSL cert from kvdb.softbridge.com
  subject:   CN = softbridge.com
  issuer:    C = US, O = Let's Encrypt, CN = E7
  notBefore: 2026-02-24 03:42:29 UTC
  notAfter:  2026-05-25 03:42:28 UTC
  sha256:    b4be4dd33a5f37550eae441bbaf7db042c7dd958ab3c6964077dafcc170a9355
accept this cert and continue (y/N/fingerprint)? SSL cert declined

KVDB Error: Error Code [1] - Unknown error.

Read a key range (range_end is exclusive)

$ vb kv get app/ app0
Unable to verify SSL cert from kvdb.softbridge.com
  subject:   CN = softbridge.com
  issuer:    C = US, O = Let's Encrypt, CN = E7
  notBefore: 2026-02-24 03:42:29 UTC
  notAfter:  2026-05-25 03:42:28 UTC
  sha256:    b4be4dd33a5f37550eae441bbaf7db042c7dd958ab3c6964077dafcc170a9355
accept this cert and continue (y/N/fingerprint)? SSL cert declined

KVDB Error: Error Code [1] - Unknown error.

Lock and unlock

$ vb kv lock app/locks/build --ttl 20
token: LzY5NGQ5Njg0OGM4ODRkN2E=

$ vb kv unlock LzY5NGQ5Njg0OGM4ODRkN2E=
unlock LzY5NGQ5Njg0OGM4ODRkN2E=

Transaction

$ vb kv txn
compares:
value("/user/123456/email") = "old.address@john.com"

success requests (get, put, del):
put /user/123456/email "old.address@john.com"
put /user/123456/phone "098-001-002"

failure requests (get, put, del):
put /user/123456/email "old.address@john.com"
put /user/123456/phone "098-001-002"

OK
OK

$ vb kv get /user/123456/email
/user/123456/email
"old.address@john.com"

$ vb kv get /user/123456/phone
/user/123456/phone
"098-001-002"

Leases

$ vb kv lease grant 60 --ID 4242
Unable to verify SSL cert from kvdb.softbridge.com
  subject:   CN = softbridge.com
  issuer:    C = US, O = Let's Encrypt, CN = E7
  notBefore: 2026-02-24 03:42:29 UTC
  notAfter:  2026-05-25 03:42:28 UTC
  sha256:    b4be4dd33a5f37550eae441bbaf7db042c7dd958ab3c6964077dafcc170a9355
accept this cert and continue (y/N/fingerprint)? SSL cert declined

KVDB Error: Error Code [1] - Unknown error.
 ��

$ vb kv lease keepalive 4242
Unable to verify SSL cert from kvdb.softbridge.com
  subject:   CN = softbridge.com
  issuer:    C = US, O = Let's Encrypt, CN = E7
  notBefore: 2026-02-24 03:42:29 UTC
  notAfter:  2026-05-25 03:42:28 UTC
  sha256:    b4be4dd33a5f37550eae441bbaf7db042c7dd958ab3c6964077dafcc170a9355
accept this cert and continue (y/N/fingerprint)? SSL cert declined

KVDB Error: Error Code [1] - Unknown error.
�L�

$ vb kv lease timetolive 4242 --keys=true
Unable to verify SSL cert from kvdb.softbridge.com
  subject:   CN = softbridge.com
  issuer:    C = US, O = Let's Encrypt, CN = E7
  notBefore: 2026-02-24 03:42:29 UTC
  notAfter:  2026-05-25 03:42:28 UTC
  sha256:    b4be4dd33a5f37550eae441bbaf7db042c7dd958ab3c6964077dafcc170a9355
accept this cert and continue (y/N/fingerprint)? SSL cert declined

KVDB Error: Error Code [1] - Unknown error.
0�3

$ vb kv lease leases
Unable to verify SSL cert from kvdb.softbridge.com
  subject:   CN = softbridge.com
  issuer:    C = US, O = Let's Encrypt, CN = E7
  notBefore: 2026-02-24 03:42:29 UTC
  notAfter:  2026-05-25 03:42:28 UTC
  sha256:    b4be4dd33a5f37550eae441bbaf7db042c7dd958ab3c6964077dafcc170a9355
accept this cert and continue (y/N/fingerprint)? SSL cert declined

KVDB Error: Error Code [1] - Unknown error.
�Z�

$ vb kv lease revoke 4242
Unable to verify SSL cert from kvdb.softbridge.com
  subject:   CN = softbridge.com
  issuer:    C = US, O = Let's Encrypt, CN = E7
  notBefore: 2026-02-24 03:42:29 UTC
  notAfter:  2026-05-25 03:42:28 UTC
  sha256:    b4be4dd33a5f37550eae441bbaf7db042c7dd958ab3c6964077dafcc170a9355
accept this cert and continue (y/N/fingerprint)? SSL cert declined

KVDB Error: Error Code [1] - Unknown error.
0��

Auth users

$ vb kv auth user add dev devpass
Unable to verify SSL cert from kvdb.softbridge.com
  subject:   CN = softbridge.com
  issuer:    C = US, O = Let's Encrypt, CN = E7
  notBefore: 2026-02-24 03:42:29 UTC
  notAfter:  2026-05-25 03:42:28 UTC
  sha256:    b4be4dd33a5f37550eae441bbaf7db042c7dd958ab3c6964077dafcc170a9355
accept this cert and continue (y/N/fingerprint)? SSL cert declined

KVDB Error: Error Code [1] - Unknown error.
���

$ vb kv auth user get dev
Unable to verify SSL cert from kvdb.softbridge.com
  subject:   CN = softbridge.com
  issuer:    C = US, O = Let's Encrypt, CN = E7
  notBefore: 2026-02-24 03:42:29 UTC
  notAfter:  2026-05-25 03:42:28 UTC
  sha256:    b4be4dd33a5f37550eae441bbaf7db042c7dd958ab3c6964077dafcc170a9355
accept this cert and continue (y/N/fingerprint)? SSL cert declined

KVDB Error: Error Code [1] - Unknown error.
�J�

$ vb kv auth user list
Unable to verify SSL cert from kvdb.softbridge.com
  subject:   CN = softbridge.com
  issuer:    C = US, O = Let's Encrypt, CN = E7
  notBefore: 2026-02-24 03:42:29 UTC
  notAfter:  2026-05-25 03:42:28 UTC
  sha256:    b4be4dd33a5f37550eae441bbaf7db042c7dd958ab3c6964077dafcc170a9355
accept this cert and continue (y/N/fingerprint)? SSL cert declined

KVDB Error: Error Code [1] - Unknown error.
�Nu

$ vb kv auth user passwd dev newpass
Unable to verify SSL cert from kvdb.softbridge.com
  subject:   CN = softbridge.com
  issuer:    C = US, O = Let's Encrypt, CN = E7
  notBefore: 2026-02-24 03:42:29 UTC
  notAfter:  2026-05-25 03:42:28 UTC
  sha256:    b4be4dd33a5f37550eae441bbaf7db042c7dd958ab3c6964077dafcc170a9355
accept this cert and continue (y/N/fingerprint)? SSL cert declined

KVDB Error: Error Code [1] - Unknown error.
��B

$ vb kv auth user grant dev root
Unable to verify SSL cert from kvdb.softbridge.com
  subject:   CN = softbridge.com
  issuer:    C = US, O = Let's Encrypt, CN = E7
  notBefore: 2026-02-24 03:42:29 UTC
  notAfter:  2026-05-25 03:42:28 UTC
  sha256:    b4be4dd33a5f37550eae441bbaf7db042c7dd958ab3c6964077dafcc170a9355
accept this cert and continue (y/N/fingerprint)? SSL cert declined

KVDB Error: Error Code [1] - Unknown error.
���

$ vb kv auth user revoke dev root
Unable to verify SSL cert from kvdb.softbridge.com
  subject:   CN = softbridge.com
  issuer:    C = US, O = Let's Encrypt, CN = E7
  notBefore: 2026-02-24 03:42:29 UTC
  notAfter:  2026-05-25 03:42:28 UTC
  sha256:    b4be4dd33a5f37550eae441bbaf7db042c7dd958ab3c6964077dafcc170a9355
accept this cert and continue (y/N/fingerprint)? SSL cert declined

KVDB Error: Error Code [1] - Unknown error.
�|�

$ vb kv auth user delete dev
Unable to verify SSL cert from kvdb.softbridge.com
  subject:   CN = softbridge.com
  issuer:    C = US, O = Let's Encrypt, CN = E7
  notBefore: 2026-02-24 03:42:29 UTC
  notAfter:  2026-05-25 03:42:28 UTC
  sha256:    b4be4dd33a5f37550eae441bbaf7db042c7dd958ab3c6964077dafcc170a9355
accept this cert and continue (y/N/fingerprint)? SSL cert declined

KVDB Error: Error Code [1] - Unknown error.
���

Auth roles

$ vb kv auth role add devrole
Unable to verify SSL cert from kvdb.softbridge.com
  subject:   CN = softbridge.com
  issuer:    C = US, O = Let's Encrypt, CN = E7
  notBefore: 2026-02-24 03:42:29 UTC
  notAfter:  2026-05-25 03:42:28 UTC
  sha256:    b4be4dd33a5f37550eae441bbaf7db042c7dd958ab3c6964077dafcc170a9355
accept this cert and continue (y/N/fingerprint)? SSL cert declined

KVDB Error: Error Code [1] - Unknown error.
���

$ vb kv auth role get devrole
Unable to verify SSL cert from kvdb.softbridge.com
  subject:   CN = softbridge.com
  issuer:    C = US, O = Let's Encrypt, CN = E7
  notBefore: 2026-02-24 03:42:29 UTC
  notAfter:  2026-05-25 03:42:28 UTC
  sha256:    b4be4dd33a5f37550eae441bbaf7db042c7dd958ab3c6964077dafcc170a9355
accept this cert and continue (y/N/fingerprint)? SSL cert declined

KVDB Error: Error Code [1] - Unknown error.
p��

$ vb kv auth role list
Unable to verify SSL cert from kvdb.softbridge.com
  subject:   CN = softbridge.com
  issuer:    C = US, O = Let's Encrypt, CN = E7
  notBefore: 2026-02-24 03:42:29 UTC
  notAfter:  2026-05-25 03:42:28 UTC
  sha256:    b4be4dd33a5f37550eae441bbaf7db042c7dd958ab3c6964077dafcc170a9355
accept this cert and continue (y/N/fingerprint)? SSL cert declined

KVDB Error: Error Code [1] - Unknown error.
�h�

$ vb kv auth role grant-permission devrole read app/ app0
Unable to verify SSL cert from kvdb.softbridge.com
  subject:   CN = softbridge.com
  issuer:    C = US, O = Let's Encrypt, CN = E7
  notBefore: 2026-02-24 03:42:29 UTC
  notAfter:  2026-05-25 03:42:28 UTC
  sha256:    b4be4dd33a5f37550eae441bbaf7db042c7dd958ab3c6964077dafcc170a9355
accept this cert and continue (y/N/fingerprint)? SSL cert declined

KVDB Error: Error Code [1] - Unknown error.
�
[

$ vb kv auth role revoke-permission devrole app/ app0
Unable to verify SSL cert from kvdb.softbridge.com
  subject:   CN = softbridge.com
  issuer:    C = US, O = Let's Encrypt, CN = E7
  notBefore: 2026-02-24 03:42:29 UTC
  notAfter:  2026-05-25 03:42:28 UTC
  sha256:    b4be4dd33a5f37550eae441bbaf7db042c7dd958ab3c6964077dafcc170a9355
accept this cert and continue (y/N/fingerprint)? SSL cert declined

KVDB Error: Error Code [1] - Unknown error.
��

$ vb kv auth role delete devrole
Unable to verify SSL cert from kvdb.softbridge.com
  subject:   CN = softbridge.com
  issuer:    C = US, O = Let's Encrypt, CN = E7
  notBefore: 2026-02-24 03:42:29 UTC
  notAfter:  2026-05-25 03:42:28 UTC
  sha256:    b4be4dd33a5f37550eae441bbaf7db042c7dd958ab3c6964077dafcc170a9355
accept this cert and continue (y/N/fingerprint)? SSL cert declined

KVDB Error: Error Code [1] - Unknown error.
���