mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-20 02:27:51 +01:00
Code Issues Projects Releases Wiki Activity
fe86c117d9
core-lightning/doc/lightning-deldatastore.7.md
Rusty Russell fe86c117d9 datastore: turn keys into arrays 
After some discussion with @shesek, and my own usage, we agreed that
a more comprehensive interface, which explicitly supports grouping,
is desirable.

Thus keys are now arrays, with the semantic that a key is either a
parent or has a value, never both.

For convenience in the JSON schema, we always return them as arrays,
though we accept simple strings as arguments.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-08-25 10:06:31 +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 c-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 comment: # (GENERATE-FROM-SCHEMA-END)

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