vincenzopalazzo
/
rgb-cln
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
rgb-cln/doc/lightning-deldatastore.7.md

54 lines
1.4 KiB
Markdown
Raw Normal View History

datastore: docs, schemas, and a test. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-08-25 03:50:12 +01:00
lightning-deldatastore -- Command for removing (plugin) data
============================================================
SYNOPSIS
--------
Remove useless \
2022-01-26 17:18:49 +00:00
**deldatastore** *key* [*generation*]
datastore: docs, schemas, and a test. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-08-25 03:50:12 +01:00
DESCRIPTION
-----------
The **deldatastore** RPC command allows plugins to delete data it has
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 06:09:48 +01: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 03:50:12 +01:00
datastore: add generation, simple atomicity. 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>
2021-08-25 03:51:04 +01:00
The command fails if the *key* isn't present, or if *generation*
is specified and the generation of the data does not exactly match.
datastore: docs, schemas, and a test. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-08-25 03:50:12 +01:00
RETURN VALUE
------------
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
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 22:33:09 +01: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 03:51:34 +01: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 which has removed 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 03:50:13 +01: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 11:07:59 +01:00
datastore: docs, schemas, and a test. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-08-25 03:50:12 +01:00
[comment]: # (GENERATE-FROM-SCHEMA-END)
The following error codes may occur:
doc: fix display of lists and code blocks in manpages. The conversion from markdown to manpages does not display lists and code blocks correctly if they are not preceded by an empty line. Changelog-None
2023-10-14 09:09:05 +01:00
datastore: add generation, simple atomicity. 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>
2021-08-25 03:51:04 +01:00
- 1200: the key does not exist
- 1201: the key does exist, but the generation is wrong
- -32602: invalid parameters
datastore: docs, schemas, and a test. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-08-25 03:50:12 +01:00
AUTHOR
------
Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible.
SEE ALSO
--------
datastore: Add datastoreusage command datastoreusage returns the total_bytes that are stored under a given {Key} or from root. {Key} is the entry point from which we begin to traverse the datastore. Changelog-Added: JSON-RPC: `datastoreusage`: returns the total bytes that are stored under a given key. Signed-off-by: Peter Neuroth <pet.v.ne@gmail.com>
2023-07-24 19:47:46 +01:00
lightning-listdatastore(7), lightning-datastore(7), lightning-datastoreusage(7)
datastore: docs, schemas, and a test. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-08-25 03:50:12 +01:00
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
schemas: deprecated is now a range. Don't assume removal is +6 months, but have a start deprecation/end support range. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2024-01-25 00:28:53 +00:00
[comment]: # ( SHA256STAMP:7eaa7b42799aa2a1ee0719abd3e1c12cd135c1031b6c363ae52e339aa5670a47)