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
0cf2c29b5c
core-lightning/doc/lightning-listdatastore.7.md

51 lines
1.3 KiB
Markdown
Raw Normal View History

datastore: docs, schemas, and a test. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-08-25 04:50:12 +02:00
lightning-listdatastore -- Command for listing (plugin) data
============================================================
SYNOPSIS
--------
Remove useless \
2022-01-26 18:18:49 +01:00
**listdatastore** [*key*]
datastore: docs, schemas, and a test. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-08-25 04:50:12 +02:00
DESCRIPTION
-----------
The **listdatastore** RPC command allows plugins to fetch data which was
doc: update c-lightning to Core Lightning almost everywhere. Mostly comments and docs: some places are actually paths, which I have avoided changing. We may migrate them slowly, particularly when they're user-visible. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-04-06 07:09:48 +02:00
stored in the Core Lightning database.
datastore: docs, schemas, and a test. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-08-25 04:50:12 +02:00
datastore: turn keys into arrays After some discussion with @shesek, and my own usage, we agreed that a more comprehensive interface, which explicitly supports grouping, is desirable. Thus keys are now arrays, with the semantic that a key is either a parent or has a value, never both. For convenience in the JSON schema, we always return them as arrays, though we accept simple strings as arguments. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-08-25 04:51:34 +02:00
All immediate children of the *key* (or root children) are returned:
a *key* with children won't have a *hex* or *generation* entry.
datastore: docs, schemas, and a test. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-08-25 04:50:12 +02:00
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:
doc: generate correct markdown from schemas. You can't start a list without a paragraph separator. ```diff --- /tmp/before 2022-07-20 22:02:23.485372596 +0930 +++ /tmp/after 2022-07-20 22:02:33.745528456 +0930 @@ -21,12 +21,16 @@ On startup of the daemon, no autoclean is set up. RETURN VALUE - On success, an object is returned, containing: - enabled (boolean): - whether invoice autocleaning is active + On success, an object is returned, containing: - If enabled is true: - expired_by (u64): how long an invoice must be ex‐ - pired (seconds) before we delete it - cycle_seconds (u64): how long an - invoice must be expired (seconds) before we delete it + • enabled (boolean): whether invoice autocleaning is active + + If enabled is true: + + • expired_by (u64): how long an invoice must be expired (seconds) be‐ + fore we delete it + • cycle_seconds (u64): how long an invoice must be expired (seconds) + before we delete it AUTHOR ZmnSCPxj <ZmnSCPxj@protonmail.com> is mainly responsible. ``` Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-05 23:33:09 +02:00
datastore: turn keys into arrays After some discussion with @shesek, and my own usage, we agreed that a more comprehensive interface, which explicitly supports grouping, is desirable. Thus keys are now arrays, with the semantic that a key is either a parent or has a value, never both. For convenience in the JSON schema, we always return them as arrays, though we accept simple strings as arguments. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-08-25 04:51:34 +02:00
- **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
datastore: allow strings. It's common, and the simplest case. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-08-25 04:50:13 +02:00
- **string** (string, optional): The data as a string, if it's valid utf-8
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-03 12:07:59 +02:00
datastore: docs, schemas, and a test. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-08-25 04:50:12 +02:00
[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>
tools/fromschema.py: don't try to handle more complex cases. We only handle top-level objects with an array of objects: make sure it is one before we call the routines. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-01-30 07:24:16 +01:00
[comment]: # ( SHA256STAMP:e2b898200862d5b924c6b206f5e168e69cb689ca79610d88039749220b820dd6)
Reference in New Issue Copy Permalink