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
38df2a3a4c
core-lightning/doc/lightning-listdatastore.7.md
Rusty Russell 6d1897b796 doc: fix GH/readthedocs rendering of manual pages. 
They render the comment as if it's in the list.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-09-05 15:02:17 +02:00

1.3 KiB
Raw Blame History

lightning-listdatastore -- Command for listing (plugin) data

SYNOPSIS

listdatastore [key]

DESCRIPTION

The listdatastore RPC command allows plugins to fetch data which was stored in the c-lightning database.

All immediate children of the key (or root children) are returned: a key with children won't have a hex or generation entry.

RETURN VALUE

On success, an object containing datastore is returned. It is an array of objects, where each object contains:

  • key (array of strings):
    • Part of the key added to the datastore
  • generation (u64, optional): The number of times this has been updated
  • hex (hex, optional): The hex data from the datastore
  • string (string, optional): The data as a string, if it's valid utf-8

The following error codes may occur:

  • -32602: invalid parameters.

AUTHOR

Rusty Russell <rusty@rustcorp.com.au> is mainly responsible.

SEE ALSO

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

RESOURCES

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