mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 18:11:28 +01:00
Code Issues Projects Releases Wiki Activity
3ce8d20a89
core-lightning/doc/lightning-datastoreusage.7.md
Peter Neuroth aab948e538 datastore: Add datastoreusage command 
datastoreusage returns the total_bytes that are stored under a given
{Key} or from root. {Key} is the entry point from which we begin to
traverse the datastore.

Changelog-Added: JSON-RPC: `datastoreusage`: returns the total bytes that are stored under a given key.

Signed-off-by: Peter Neuroth <pet.v.ne@gmail.com>
2023-10-26 12:58:04 +10:30

1.2 KiB
Raw Blame History

lightning-datastoreusage -- Command for listing datastore usage info

SYNOPSIS

datastoreusage

DESCRIPTION

The datastoreusage RPC command allows the caller to fetch the total bytes that are stored under a certain key (or from the root), including the size of the key.

All descendants of the key (or root) are taken into account. RETURN VALUE

On success, an object containing datastoreusage is returned. It is an object containing:

  • key (string): The key from which the database was traversed.
  • total_bytes (u64): The total bytes that are stored under the key, including the all descendants data and the size of the keys themselves.

AUTHOR

Peter Neuroth <pet.v.ne@gmail.com> is mainly responsible.

SEE ALSO

lightning-datastore(7), lightning-deldatastore(7), lightning-listdatastore(7)

RESOURCES

Main web site: https://github.com/ElementsProject/lightning