mirror of
https://github.com/aljazceru/lightning.git
synced 2025-12-23 09:04:22 +01:00
533571a655
We add a generation counter, and allow update or del conditional on a given generation. Formalizes error codes, too, since we have more now. Suggested-by: @shesek Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
48 lines
1.2 KiB
Markdown
48 lines
1.2 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
|
|
- **generation** (u64): The number of times this has been updated
|
|
- **hex** (hex): 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:a6503e3d2da8f9a35a0d461b5b93248f3fea306371ad62f98df613efea51959d)
|