core-lightning/doc/lightning-autoclean-once.7.md
ShahanaFarooqui b0da807700 doc: Markdown cleanup
This commit will remove parameter descriptions from RPC markdown but we will fix it in next commits by reading these descriptions directly from json.

- Removing parameter description text
- Adding/removing newlines for cleaner formatting
- Adding ERRORS title wherever needed
- Updating titles for consistency
- Adding resources links
2024-03-19 14:58:59 +10:30

2.1 KiB

lightning-autoclean-once -- A single deletion of old invoices/payments/forwards

SYNOPSIS

autoclean-once subsystem age

DESCRIPTION

The autoclean-once RPC command tell the autoclean plugin to do a single sweep to delete old entries. This is a manual alternative (or addition) to the various autoclean-...-age parameters which cause autoclean to run once per hour: see lightningd-config(5).

RETURN VALUE

On success, an object containing autoclean is returned. It is an object containing:

  • succeededforwards (object, optional):
    • cleaned (u64): total number of deletions done this run
    • uncleaned (u64): the total number of entries not deleted this run
  • failedforwards (object, optional):
    • cleaned (u64): total number of deletions done this run
    • uncleaned (u64): the total number of entries not deleted this run
  • succeededpays (object, optional):
    • cleaned (u64): total number of deletions done this run
    • uncleaned (u64): the total number of entries not deleted this run
  • failedpays (object, optional):
    • cleaned (u64): total number of deletions done this run
    • uncleaned (u64): the total number of entries not deleted this run
  • paidinvoices (object, optional):
    • cleaned (u64): total number of deletions done this run
    • uncleaned (u64): the total number of entries not deleted this run
  • expiredinvoices (object, optional):
    • cleaned (u64): total number of deletions done this run
    • uncleaned (u64): the total number of entries not deleted this run

AUTHOR

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

SEE ALSO

lightningd-config(5), lightning-autoclean-status(7)

RESOURCES

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