core-lightning/doc/lightning-deldatastore.7.md
niftynei ba7d4a8f6b make-schema: don't include tools/fromschema.py in SHASUMS
We were including the entire list of prerequisites when generating a
shastamp, which for schemas includes the `tools/fromschema.py` doc.

This meant all of our shasums were updating anytime this tool file
changed.

Instead, we just include the first prerequisite.

See: https://www.gnu.org/software/make/manual/html_node/Automatic-Variables.html#Automatic-Variables
2022-07-14 12:24:48 -05:00

52 lines
1.4 KiB
Markdown

lightning-deldatastore -- Command for removing (plugin) data
============================================================
SYNOPSIS
--------
**deldatastore** *key* [*generation*]
DESCRIPTION
-----------
The **deldatastore** RPC command allows plugins to delete data it has
stored in the Core Lightning database.
The command fails if the *key* isn't present, or if *generation*
is specified and the generation of the data does not exactly match.
RETURN VALUE
------------
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
- **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
- **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:
- 1200: the key does not exist
- 1201: the key does exist, but the generation is wrong
- -32602: invalid parameters
AUTHOR
------
Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible.
SEE ALSO
--------
lightning-listdatastore(7), lightning-datastore(7)
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:83a7e89ed44c6dbf744d1327337e29393f9095628bd95fffe59ec5014ee0a483)