mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-03-05 11:39:39 +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>
56 lines
1.3 KiB
Groff
Generated
56 lines
1.3 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 (string): The key which has been removed from the datastore
|
|
.IP \[bu]
|
|
\fBgeneration\fR (u64): The number of times this has been updated
|
|
.IP \[bu]
|
|
\fBhex\fR (hex): 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:784f58fc76fc32b92d043b67b0b7efb88534dd29a7fabda2d705cdc0611e3c11
|