Skip to main content

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

​
Static Public Attributes

const string MAX_SEGMENT_SIZE = “max_segment_size”
 Maximum size of an individual segment file.
 
const string SEGMENT_COUNT = “segment_count”
 Approximate number of segment files to split the WAL across.
 
const string SYNC_POLICY = “sync_policy”
 Maximum size of an individual segment file.
 
const string NONE = “none”
 Disables the WAL.
 
const string BACKGROUND = “background”
 WAL entries are periodically written instead of immediately after each operation.
 
const string FLUSH = “flush”
 Protects entries in the event of a database crash.
 
const string FSYNC = “fsync”
 Protects entries in the event of an OS crash.
 
const string FLUSH_FREQUENCY = “flush_frequency”
 Specifies how frequently WAL entries are written with background sync.
 
const string CHECKSUM = “checksum”
 If TRUE each entry will be checked against a protective checksum.
 
const string TRUE = “true”
 A boolean constant for the AlterWalRequest.Options options.
 
const string FALSE = “false”
 A boolean constant for the AlterWalRequest.Options options.
 
const string OVERRIDE_NON_DEFAULT = “override_non_default”
 If TRUE tables with unique WAL settings will be overridden when applying a system level change.
 
const string RESTORE_SYSTEM_SETTINGS = “restore_system_settings”
 If TRUE tables with unique WAL settings will be reverted to the current global settings.
 
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.
 

​
Detailed Description

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

Optional parameters.

Definition at line 22 of file AlterWal.cs.

​
Member Data Documentation

​
◆ BACKGROUND

const string kinetica.AlterWalRequest.Options.BACKGROUND = “background”
 static

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

Definition at line 67 of file AlterWal.cs.

​
◆ CHECKSUM

const string kinetica.AlterWalRequest.Options.CHECKSUM = “checksum”
 static

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

Supported values:

The default value is TRUE.

Definition at line 97 of file AlterWal.cs.

​
◆ FALSE

const string kinetica.AlterWalRequest.Options.FALSE = “false”
 static

A boolean constant for the AlterWalRequest.Options options.

Definition at line 105 of file AlterWal.cs.

​
◆ FLUSH

const string kinetica.AlterWalRequest.Options.FLUSH = “flush”
 static

Protects entries in the event of a database crash.

Definition at line 71 of file AlterWal.cs.

​
◆ FLUSH_FREQUENCY

const string kinetica.AlterWalRequest.Options.FLUSH_FREQUENCY = “flush_frequency”
 static

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 80 of file AlterWal.cs.

​
◆ FSYNC

const string kinetica.AlterWalRequest.Options.FSYNC = “fsync”
 static

Protects entries in the event of an OS crash.

Definition at line 74 of file AlterWal.cs.

​
◆ MAX_SEGMENT_SIZE

const string kinetica.AlterWalRequest.Options.MAX_SEGMENT_SIZE = “max_segment_size”
 static

Maximum size of an individual segment file.

Definition at line 25 of file AlterWal.cs.

​
◆ NONE

const string kinetica.AlterWalRequest.Options.NONE = “none”
 static

Disables the WAL.

Definition at line 63 of file AlterWal.cs.

​
◆ OVERRIDE_NON_DEFAULT

const string kinetica.AlterWalRequest.Options.OVERRIDE_NON_DEFAULT = “override_non_default”
 static

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

Supported values:

The default value is FALSE.

Definition at line 123 of file AlterWal.cs.

​
◆ PERSIST

const string kinetica.AlterWalRequest.Options.PERSIST = “persist”
 static

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:

The default value is TRUE.

Definition at line 163 of file AlterWal.cs.

​
◆ RESTORE_SYSTEM_SETTINGS

const string kinetica.AlterWalRequest.Options.RESTORE_SYSTEM_SETTINGS = “restore_system_settings”
 static

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:

The default value is FALSE.

Definition at line 142 of file AlterWal.cs.

​
◆ SEGMENT_COUNT

const string kinetica.AlterWalRequest.Options.SEGMENT_COUNT = “segment_count”
 static

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 kinetica.AlterWalRequest.Options.SYNC_POLICY = “sync_policy”
 static

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 60 of file AlterWal.cs.

​
◆ TRUE

const string kinetica.AlterWalRequest.Options.TRUE = “true”
 static

A boolean constant for the AlterWalRequest.Options options.

Definition at line 101 of file AlterWal.cs.

The documentation for this struct was generated from the following files:
  • _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/AlterWal.cs
  • Kinetica/Protocol/AlterWal.cs