mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-02-21 14:24:09 +01:00
fe86c117d9
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>
62 lines
1.4 KiB
Groff
Generated
62 lines
1.4 KiB
Groff
Generated
.TH "LIGHTNING-DELDATASTORE" "7" "" "" "lightning-deldatastore"
|
|
.SH NAME
|
|
lightning-deldatastore - Command for removing (plugin) data
|
|
.SH SYNOPSIS
|
|
|
|
\fBdeldatastore\fR \fIkey\fR [\fIgeneration\fR]
|
|
|
|
.SH DESCRIPTION
|
|
|
|
The \fBdeldatastore\fR RPC command allows plugins to delete data it has
|
|
stored in the c-lightning database\.
|
|
|
|
|
|
The command fails if the \fIkey\fR isn't present, or if \fIgeneration\fR
|
|
is specified and the generation of the data does not exactly match\.
|
|
|
|
.SH RETURN VALUE
|
|
|
|
On success, an object is returned, containing:
|
|
|
|
.RS
|
|
.IP \[bu]
|
|
\fBkey\fR (array of strings):
|
|
.RS
|
|
.IP \[bu]
|
|
Part of the key added to the datastore
|
|
|
|
.RE
|
|
|
|
.IP \[bu]
|
|
\fBgeneration\fR (u64, optional): The number of times this has been updated
|
|
.IP \[bu]
|
|
\fBhex\fR (hex, optional): The hex data which has removed from the datastore
|
|
.IP \[bu]
|
|
\fBstring\fR (string, optional): The data as a string, if it's valid utf-8
|
|
|
|
.RE
|
|
|
|
The following error codes may occur:
|
|
|
|
.RS
|
|
.IP \[bu]
|
|
1200: the key does not exist
|
|
.IP \[bu]
|
|
1201: the key does exist, but the generation is wrong
|
|
.IP \[bu]
|
|
-32602: invalid parameters
|
|
|
|
.RE
|
|
.SH AUTHOR
|
|
|
|
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
|
|
|
|
.SH SEE ALSO
|
|
|
|
\fBlightning-listdatastore\fR(7), \fBlightning-datastore\fR(7)
|
|
|
|
.SH RESOURCES
|
|
|
|
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
|
|
|
\" SHA256STAMP:5450068ba0e62da8f46465b4f87cce4b4a59d064efbb13d03b24228790173dcc
|