Files
lightning/doc/lightning-listdatastore.7.md
Rusty Russell 04b59d991a doc: always escape underscores in property names
If there's only a single underscore, lowdown ignores it, but if there are multiple
(see min_final_cltv_expiry) it decides we're trying to highlight part of the word.

Reported-by: @wtogami
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:45448ccd8947127b2008b4b7d8ab30bb348a45c9ddbced2c690d8b08a102d058)