A set of parameters for GPUdb::alterWal. More...

#include <gpudb/protocol/alter_wal.h>

Public Member Functions
	AlterWalRequest ()
	Constructs an AlterWalRequest object with default parameters. More...

	AlterWalRequest (const std::vector< std::string > &tableNames_, const std::map< std::string, std::string > &options_)
	Constructs an AlterWalRequest object with the specified parameters. More...

Public Attributes
std::vector< std::string >	tableNames
	List of tables to modify. More...

std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::alterWal.

Alters table wal settings. Returns information about the requested table wal modifications.

Definition at line 18 of file alter_wal.h.

Constructor & Destructor Documentation

◆ AlterWalRequest() [1/2]

gpudb::AlterWalRequest::AlterWalRequest ( )

inline

Constructs an AlterWalRequest object with default parameters.

Definition at line 23 of file alter_wal.h.

◆ AlterWalRequest() [2/2]

gpudb::AlterWalRequest::AlterWalRequest	(	const std::vector< std::string > &	tableNames_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs an AlterWalRequest object with the specified parameters.

Parameters

[in]	tableNames_	List of tables to modify. An asterisk changes the system settings.
[in]	options_	Optional parameters. alter_wal_max_segment_size: Maximum size of an individual segment file alter_wal_segment_count: Approximate number of segment files to split the wal across. Must be at least two. alter_wal_sync_policy: Maximum size of an individual segment file. Supported values: alter_wal_none: Disables the wal alter_wal_background: Wal entries are periodically written instead of immediately after each operation alter_wal_flush: Protects entries in the event of a database crash alter_wal_fsync: Protects entries in the event of an OS crash alter_wal_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 '*'. alter_wal_checksum: If true each entry will be checked against a protective checksum. Supported values: alter_wal_true alter_wal_false The default value is alter_wal_true. alter_wal_override_non_default: If true tables with unique wal settings will be overridden when applying a system level change. Supported values: alter_wal_true alter_wal_false The default value is alter_wal_false. alter_wal_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. Supported values: alter_wal_true alter_wal_false The default value is alter_wal_false. alter_wal_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. Supported values: alter_wal_true alter_wal_false The default value is alter_wal_true. The default value is an empty map.

Definition at line 143 of file alter_wal.h.

Member Data Documentation

◆ options

std::map<std::string, std::string> gpudb::AlterWalRequest::options

Optional parameters.

alter_wal_max_segment_size: Maximum size of an individual segment file
alter_wal_segment_count: Approximate number of segment files to split the wal across. Must be at least two.
alter_wal_sync_policy: Maximum size of an individual segment file. Supported values:
- alter_wal_none: Disables the wal
- alter_wal_background: Wal entries are periodically written instead of immediately after each operation
- alter_wal_flush: Protects entries in the event of a database crash
- alter_wal_fsync: Protects entries in the event of an OS crash
alter_wal_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 '*'.
alter_wal_checksum: If true each entry will be checked against a protective checksum. Supported values:
- alter_wal_true
- alter_wal_false
The default value is alter_wal_true.
alter_wal_override_non_default: If true tables with unique wal settings will be overridden when applying a system level change. Supported values:
- alter_wal_true
- alter_wal_false
The default value is alter_wal_false.
alter_wal_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. Supported values:
- alter_wal_true
- alter_wal_false
The default value is alter_wal_false.
alter_wal_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. Supported values:
- alter_wal_true
- alter_wal_false
The default value is alter_wal_true.

The default value is an empty map.

Definition at line 231 of file alter_wal.h.

◆ tableNames

std::vector<std::string> gpudb::AlterWalRequest::tableNames

List of tables to modify.

An asterisk changes the system settings.

Definition at line 152 of file alter_wal.h.

The documentation for this struct was generated from the following file:

gpudb/protocol/alter_wal.h

Public Member Functions