Files
lightning/doc/lightning-deldatastore.7.md
Rusty Russell 8f1164365e doc: generate correct markdown from schemas.
You can't start a list without a paragraph separator.

```diff
 --- /tmp/before	2022-07-20 22:02:23.485372596 +0930
 +++ /tmp/after	2022-07-20 22:02:33.745528456 +0930
 @@ -21,12 +21,16 @@
         On startup of the daemon, no autoclean is set up.
  
  RETURN VALUE
 -       On success, an object is returned,  containing:  -  enabled  (boolean):
 -       whether invoice autocleaning is active
 +       On success, an object is returned, containing:
  
 -       If enabled is true: - expired_by (u64): how long an invoice must be ex‐
 -       pired (seconds) before we delete it - cycle_seconds (u64): how long  an
 -       invoice must be expired (seconds) before we delete it
 +       • enabled (boolean): whether invoice autocleaning is active
 +
 +       If enabled is true:
 +
 +       • expired_by (u64): how long an invoice must be expired  (seconds)  be‐
 +         fore we delete it
 +       • cycle_seconds  (u64):  how  long an invoice must be expired (seconds)
 +         before we delete it
  
  AUTHOR
         ZmnSCPxj <ZmnSCPxj@protonmail.com> is mainly responsible.
```

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-08 00:36:51 +03:00

1.4 KiB

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