Files
lightning/doc/lightning-listdatastore.7.md
Rusty Russell bcabb3825f Makefile: Revert ba7d4a8f6b (make-schema: don't include tools/fromschema.py in SHASUMS)
1. If the tool changes, you need to regenerate since the output may
   change.

2. This didn't just filter that out, ignored all but the first
   dependency, which made bisecting the bookkeeper plugin a nightmare:
   it didn't regenerate the .po file, causing random crashes.

If we want this, try $(filter-out tools/fromschema.py) instead.  But I
don't think we want that.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-08 00:36:51 +03:00

51 lines
1.3 KiB
Markdown

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 Core 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
------------
[comment]: # (GENERATE-FROM-SCHEMA-START)
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
[comment]: # (GENERATE-FROM-SCHEMA-END)
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>
[comment]: # ( SHA256STAMP:3b6eb48324fe4bab31a40460af1d5c98b8a938f27c1af758b15c955bb2204e58)