2021-08-25 12:20:12 +09:30
|
|
|
.TH "LIGHTNING-LISTDATASTORE" "7" "" "" "lightning-listdatastore"
|
|
|
|
|
.SH NAME
|
|
|
|
|
lightning-listdatastore - Command for listing (plugin) data
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
|
|
|
|
|
\fBlistdatastore\fR [\fIkey\fR]
|
|
|
|
|
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
|
|
|
|
|
The \fBlistdatastore\fR RPC command allows plugins to fetch data which was
|
|
|
|
|
stored in the c-lightning database\.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
All entries are returned in \fIkey\fR isn't present; if \fIkey\fR is present,
|
|
|
|
|
zero or one entries are returned\.
|
|
|
|
|
|
|
|
|
|
.SH RETURN VALUE
|
|
|
|
|
|
|
|
|
|
On success, an object containing \fBdatastore\fR is returned\. It is an array of objects, where each object contains:
|
|
|
|
|
|
|
|
|
|
.RS
|
|
|
|
|
.IP \[bu]
|
|
|
|
|
\fBkey\fR (string): The key which from the datastore
|
|
|
|
|
.IP \[bu]
|
|
|
|
|
\fBhex\fR (hex): The hex data from the datastore
|
2021-08-25 12:20:13 +09:30
|
|
|
.IP \[bu]
|
|
|
|
|
\fBstring\fR (string, optional): The data as a string, if it's valid utf-8
|
2021-08-25 12:20:12 +09:30
|
|
|
|
|
|
|
|
.RE
|
|
|
|
|
|
|
|
|
|
The following error codes may occur:
|
|
|
|
|
|
|
|
|
|
.RS
|
|
|
|
|
.IP \[bu]
|
|
|
|
|
-32602: invalid parameters\.
|
|
|
|
|
|
|
|
|
|
.RE
|
|
|
|
|
.SH AUTHOR
|
|
|
|
|
|
|
|
|
|
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
|
|
|
|
|
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
|
|
|
|
|
\fBlightning-datastore\fR(7), \fBlightning-deldatastore\fR(7)
|
|
|
|
|
|
|
|
|
|
.SH RESOURCES
|
|
|
|
|
|
|
|
|
|
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
|
|
|
|
|
2021-08-25 12:20:13 +09:30
|
|
|
\" SHA256STAMP:bcc83095fc1695b0c81a2763109e280d711e29edbc395672314d052f9d99a72c
|
