Files
lightning/doc/lightning-listdatastore.7.md
Rusty Russell dfe2693bbd datastore: docs, schemas, and a test.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-08-25 10:06:31 +02:00

46 lines
1.1 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 c-lightning database.
All entries are returned in *key* isn't present; if *key* is present,
zero or one entries are returned.
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** (string): The key which from the datastore
- **hex** (hex): The hex data from the datastore
[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:660d1723bcea3d4800db72a9204ed577426e7b3ab99f491145e633df89a46fac)