aljaz/lightning
1
0
Fork 0
mirror of https://github.com/aljazceru/lightning.git synced 2025-12-19 15:14:23 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
e711f6c589edff821ee54b5a8218d8b5867c4706
lightning/doc/lightning-datastore.7.md
Rusty Russell e711f6c589 datastore: allow strings. 
It's common, and the simplest case.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-08-25 10:06:31 +02:00

1.2 KiB
Raw Blame History

lightning-datastore -- Command for storing (plugin) data

SYNOPSIS

datastore key [string|hex]

DESCRIPTION

The datastore RPC command allows plugins to store data in the c-lightning database, for later retrieval.

There can only be one entry for each key, so prefixing with the plugin name (e.g. summary.) is recommended.

RETURN VALUE

On success, an object is returned, containing:

  • key (string): The key which has been added to the datastore
  • hex (hex): The hex data which has been added to the datastore
  • string (string, optional): The data as a string, if it's valid utf-8 comment: # (GENERATE-FROM-SCHEMA-END)

The main cause of failure is an already-existing entry.

The following error codes may occur:

  • -32602: invalid parameters, including already-existing key.

AUTHOR

Rusty Russell <rusty@rustcorp.com.au> is mainly responsible.

SEE ALSO

lightning-listdatastore(7), lightning-deldatastore(7)

RESOURCES

Main web site: https://github.com/ElementsProject/lightning