AlterWalRequest.Options Struct Reference

A set of string constants for the parameter options. More...

Public Attributes
const string	MAX_SEGMENT_SIZE = "max_segment_size"
	Maximum size of an individual segment file. More...
const string	SEGMENT_COUNT = "segment_count"
	Approximate number of segment files to split the WAL across. More...
const string	SYNC_POLICY = "sync_policy"
	Maximum size of an individual segment file. More...
const string	NONE = "none"
	Disables the WAL. More...
const string	BACKGROUND = "background"
	WAL entries are periodically written instead of immediately after each operation. More...
const string	FLUSH = "flush"
	Protects entries in the event of a database crash. More...
const string	FSYNC = "fsync"
	Protects entries in the event of an OS crash. More...
const string	FLUSH_FREQUENCY = "flush_frequency"
	Specifies how frequently WAL entries are written with background sync. More...
const string	CHECKSUM = "checksum"
	If TRUE each entry will be checked against a protective checksum. More...
const string	TRUE = "true"
const string	FALSE = "false"
const string	OVERRIDE_NON_DEFAULT = "override_non_default"
	If TRUE tables with unique WAL settings will be overridden when applying a system level change. More...
const string	RESTORE_SYSTEM_SETTINGS = "restore_system_settings"
	If TRUE tables with unique WAL settings will be reverted to the current global settings. More...
const string	PERSIST = "persist"
	If TRUE and a system-level change was requested, the system configuration will be written to disk upon successful application of this request. More...

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 22 of file AlterWal.cs.

Member Data Documentation

BACKGROUND

const string AlterWalRequest.Options.BACKGROUND = "background"

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

Definition at line 63 of file AlterWal.cs.

CHECKSUM

const string AlterWalRequest.Options.CHECKSUM = "checksum"

If TRUE each entry will be checked against a protective checksum.

Supported values:

• TRUE
• FALSE

The default value is TRUE.

Definition at line 91 of file AlterWal.cs.

FALSE

const string AlterWalRequest.Options.FALSE = "false"

Definition at line 94 of file AlterWal.cs.

FLUSH

const string AlterWalRequest.Options.FLUSH = "flush"

Protects entries in the event of a database crash.

Definition at line 67 of file AlterWal.cs.

FLUSH_FREQUENCY

const string AlterWalRequest.Options.FLUSH_FREQUENCY = "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 '*'.

Definition at line 76 of file AlterWal.cs.

FSYNC

const string AlterWalRequest.Options.FSYNC = "fsync"

Protects entries in the event of an OS crash.

Definition at line 70 of file AlterWal.cs.

MAX_SEGMENT_SIZE

const string AlterWalRequest.Options.MAX_SEGMENT_SIZE = "max_segment_size"

Maximum size of an individual segment file.

Definition at line 25 of file AlterWal.cs.

NONE

const string AlterWalRequest.Options.NONE = "none"

Disables the WAL.

Definition at line 59 of file AlterWal.cs.

OVERRIDE_NON_DEFAULT

const string AlterWalRequest.Options.OVERRIDE_NON_DEFAULT = "override_non_default"

If TRUE tables with unique WAL settings will be overridden when applying a system level change.

Supported values:

• TRUE
• FALSE

The default value is FALSE.

Definition at line 110 of file AlterWal.cs.

PERSIST

const string AlterWalRequest.Options.PERSIST = "persist"

If TRUE and a system-level change was requested, the system configuration will be written to disk upon successful application of this request.

Supported values:

• TRUE
• FALSE

The default value is TRUE.

Definition at line 142 of file AlterWal.cs.

RESTORE_SYSTEM_SETTINGS

const string AlterWalRequest.Options.RESTORE_SYSTEM_SETTINGS = "restore_system_settings"

If TRUE tables with unique WAL settings will be reverted to the current global settings.

Supported values:

• TRUE
• FALSE

The default value is FALSE.

Definition at line 126 of file AlterWal.cs.

SEGMENT_COUNT

const string AlterWalRequest.Options.SEGMENT_COUNT = "segment_count"

Approximate number of segment files to split the WAL across.

Must be at least two.

Definition at line 30 of file AlterWal.cs.

SYNC_POLICY

const string AlterWalRequest.Options.SYNC_POLICY = "sync_policy"

Maximum size of an individual segment file.

Supported values:

• 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.

Definition at line 56 of file AlterWal.cs.

TRUE

const string AlterWalRequest.Options.TRUE = "true"

Definition at line 93 of file AlterWal.cs.

---

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

• Kinetica/Protocol/AlterWal.cs