kinetica.AlterWalRequest Class Reference
A set of parameters for Kinetica.alterWal. More...
Inheritance diagram for kinetica.AlterWalRequest:
Collaboration diagram for kinetica.AlterWalRequest:
Classes | |
| struct | Options |
| A set of string constants for the parameter options. More... | |
Public Member Functions | |
| AlterWalRequest () | |
| Constructs an AlterWalRequest object with default parameters. More... | |
| AlterWalRequest (IList< string > table_names, IDictionary< string, string > options=null) | |
| Constructs an AlterWalRequest object with the specified parameters. More... | |
| Public Member Functions inherited from kinetica.KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type More... | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type More... | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object More... | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object More... | |
Properties | |
| IList< string > | table_names = new List<string>() [get, set] |
| List of tables to modify. More... | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Optional parameters. More... | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from kinetica.KineticaData | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. More... | |
Detailed Description
A set of parameters for Kinetica.alterWal.
Alters table wal settings. Returns information about the requested table wal modifications.
Definition at line 17 of file AlterWal.cs.
Constructor & Destructor Documentation
◆ AlterWalRequest() [1/2]
|
inline |
Constructs an AlterWalRequest object with default parameters.
Definition at line 286 of file AlterWal.cs.
◆ AlterWalRequest() [2/2]
|
inline |
Constructs an AlterWalRequest object with the specified parameters.
- Parameters
-
table_names List of tables to modify. An asterisk changes the system settings. options Optional parameters. - 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. 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
- 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. Supported values: The default value is TRUE.
- OVERRIDE_NON_DEFAULT: If TRUE tables with unique wal settings will be overridden when applying a system level change. Supported values: 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. Supported values: 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. Supported values: The default value is TRUE.
Definition at line 422 of file AlterWal.cs.
Property Documentation
◆ options
|
getset |
Optional parameters.
- 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. 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
- 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. Supported values: The default value is TRUE.
- OVERRIDE_NON_DEFAULT: If TRUE tables with unique wal settings will be overridden when applying a system level change. Supported values: 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. Supported values: 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. Supported values: The default value is TRUE.
The default value is an empty Dictionary.
Definition at line 282 of file AlterWal.cs.
◆ table_names
|
getset |
List of tables to modify.
An asterisk changes the system settings.
Definition at line 151 of file AlterWal.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/AlterWal.cs
