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

Alters table write-ahead log (WAL) settings. Returns information about the requested table WAL modifications.

Parameters

table_names (list of str) –

List of tables to modify. An asterisk changes the system settings. 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:

  • max_segment_size – Maximum size of an individual segment file.

  • segment_count – Approximate number of segment files to split the WAL across. Must be at least two.

  • sync_policy – Maximum size of an individual segment file. Allowed values are:

    • none – Disables the WAL.

    • background – WAL entries are periodically written instead of immediately after each operation.

    • flush – Protects entries in the event of a database crash.

    • fsync – Protects entries in the event of an OS crash.

  • flush_frequency – Specifies how frequently WAL entries are written with background sync. This is a global setting and can only be used with the system options.table_names specifier ‘*’.

  • checksum – If true each entry will be checked against a protective checksum. Allowed values are:

    • true

    • false

    The default value is ‘true’.

  • override_non_default – If true tables with unique WAL settings will be overridden when applying a system level change. Allowed values are:

    • true

    • false

    The default value is ‘false’.

  • restore_system_settings – If true tables with unique WAL settings will be reverted to the current global settings. Cannot be used in conjunction with any other option. Allowed values are:

    • true

    • false

    The default value is ‘false’.

  • persist – If true and a system-level change was requested, the system configuration will be written to disk upon successful application of this request. This will commit the changes from this request and any additional in-memory modifications. Allowed values are:

    • true

    • false

    The default value is ‘true’.

The default value is an empty dict ( ).

Returns

A dict with the following entries–

info (dict of str to str) –

Additional information.