mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-02-22 22:45:27 +01:00
Code Issues Projects Releases Wiki Activity
core-lightning/doc/lightning-deldatastore.7.md
Tony Aldon 8f6a02c182 doc: fix display of lists and code blocks in manpages. 
The conversion from markdown to manpages does not display lists and
code blocks correctly if they are not preceded by an empty line.

Changelog-None
2023-10-14 17:55:51 +02:00

1.4 KiB
Raw Blame History

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

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

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