Skip to main content
show_wal(table_names=None, options=)[source]

Requests table write-ahead log (WAL) properties. Returns information about the requested table WAL entries.

Parameters

table_names (list of str) –

List of tables to query. An asterisk returns all tables. The user can provide a single element (which will be automatically promoted to a list internally) or a list.

options (dict of str to str) –

Optional parameters. Allowed keys are:

  • show_settings – If true include a map of the WAL settings for the requested tables. Allowed values are:

    • true

    • false

    The default value is ‘true’.

The default value is an empty dict ( ).

Returns

A dict with the following entries–

table_names (list of str) –

List of returned tables.

sizes (list of lists of longs) –

List of current WAL usage.

capacities (list of longs) –

List of WAL capacities.

uncommitted (list of lists of longs) –

List of number of uncommitted entries.

settings (list of dicts of str to str) –

List of table WAL settings.

info (dict of str to str) –

Additional information.