Kinetica C# API  Version 6.2.0.1
Public Attributes | List of all members
kinetica.AlterTableRequest.Options Struct Reference

Optional parameters. More...

Public Attributes

const string COLUMN_DEFAULT_VALUE = "column_default_value"
 When adding a column, set a default value for existing records. More...
 
const string COLUMN_PROPERTIES = "column_properties"
 When adding or changing a column, set the column properties (strings, separated by a comma: data, store_only, text_search, char8, int8 etc). More...
 
const string COLUMN_TYPE = "column_type"
 When adding or changing a column, set the column type (strings, separated by a comma: int, double, string, null etc). More...
 
const string COMPRESSION_TYPE = "compression_type"
 When setting column compression (set_column_compression for action), compression type to use: none (to use no compression) or a valid compression type. More...
 
const string NONE = "none"
 
const string SNAPPY = "snappy"
 
const string LZ4 = "lz4"
 
const string LZ4HC = "lz4hc"
 
const string COPY_VALUES_FROM_COLUMN = "copy_values_from_column"
 please see add_column_expression instead. More...
 
const string RENAME_COLUMN = "rename_column"
 When changing a column, specify new column name. More...
 
const string VALIDATE_CHANGE_COLUMN = "validate_change_column"
 When changing a column, validate the change before applying it. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string UPDATE_LAST_ACCESS_TIME = "update_last_access_time"
 Indicates whether need to update the last_access_time. More...
 
const string ADD_COLUMN_EXPRESSION = "add_column_expression"
 expression for new column's values (optional with add_column). More...
 

Detailed Description

Optional parameters.

  • COLUMN_DEFAULT_VALUE: When adding a column, set a default value for existing records. For nullable columns, the default value will be null, regardless of data type.
  • COLUMN_PROPERTIES: When adding or changing a column, set the column properties (strings, separated by a comma: data, store_only, text_search, char8, int8 etc).
  • COLUMN_TYPE: When adding or changing a column, set the column type (strings, separated by a comma: int, double, string, null etc).
  • COMPRESSION_TYPE: When setting column compression (set_column_compression for ), compression type to use: none (to use no compression) or a valid compression type. Supported values: The default value is SNAPPY.
  • COPY_VALUES_FROM_COLUMN: please see add_column_expression instead.
  • RENAME_COLUMN: When changing a column, specify new column name.
  • VALIDATE_CHANGE_COLUMN: When changing a column, validate the change before applying it. If true, then validate all values. A value too large (or too long) for the new type will prevent any change. If false, then when a value is too large or long, it will be truncated. Supported values: The default value is TRUE.
  • UPDATE_LAST_ACCESS_TIME: Indicates whether need to update the last_access_time. Supported values: The default value is TRUE.
  • ADD_COLUMN_EXPRESSION: expression for new column's values (optional with add_column). Any valid expressions including existing columns.

The default value is an empty Dictionary. A set of string constants for the parameter options.

Definition at line 491 of file AlterTable.cs.

Member Data Documentation

◆ ADD_COLUMN_EXPRESSION

const string kinetica.AlterTableRequest.Options.ADD_COLUMN_EXPRESSION = "add_column_expression"

expression for new column's values (optional with add_column).

Any valid expressions including existing columns.

Definition at line 590 of file AlterTable.cs.

◆ COLUMN_DEFAULT_VALUE

const string kinetica.AlterTableRequest.Options.COLUMN_DEFAULT_VALUE = "column_default_value"

When adding a column, set a default value for existing records.

For nullable columns, the default value will be null, regardless of data type.

Definition at line 497 of file AlterTable.cs.

◆ COLUMN_PROPERTIES

const string kinetica.AlterTableRequest.Options.COLUMN_PROPERTIES = "column_properties"

When adding or changing a column, set the column properties (strings, separated by a comma: data, store_only, text_search, char8, int8 etc).

Definition at line 502 of file AlterTable.cs.

◆ COLUMN_TYPE

const string kinetica.AlterTableRequest.Options.COLUMN_TYPE = "column_type"

When adding or changing a column, set the column type (strings, separated by a comma: int, double, string, null etc).

Definition at line 507 of file AlterTable.cs.

◆ COMPRESSION_TYPE

const string kinetica.AlterTableRequest.Options.COMPRESSION_TYPE = "compression_type"

When setting column compression (set_column_compression for action), compression type to use: none (to use no compression) or a valid compression type.

Supported values:

The default value is SNAPPY.

Definition at line 534 of file AlterTable.cs.

◆ COPY_VALUES_FROM_COLUMN

const string kinetica.AlterTableRequest.Options.COPY_VALUES_FROM_COLUMN = "copy_values_from_column"

please see add_column_expression instead.

Definition at line 541 of file AlterTable.cs.

◆ FALSE

const string kinetica.AlterTableRequest.Options.FALSE = "false"

Definition at line 569 of file AlterTable.cs.

◆ LZ4

const string kinetica.AlterTableRequest.Options.LZ4 = "lz4"

Definition at line 537 of file AlterTable.cs.

◆ LZ4HC

const string kinetica.AlterTableRequest.Options.LZ4HC = "lz4hc"

Definition at line 538 of file AlterTable.cs.

◆ NONE

const string kinetica.AlterTableRequest.Options.NONE = "none"

Definition at line 535 of file AlterTable.cs.

◆ RENAME_COLUMN

const string kinetica.AlterTableRequest.Options.RENAME_COLUMN = "rename_column"

When changing a column, specify new column name.

Definition at line 545 of file AlterTable.cs.

◆ SNAPPY

const string kinetica.AlterTableRequest.Options.SNAPPY = "snappy"

Definition at line 536 of file AlterTable.cs.

◆ TRUE

const string kinetica.AlterTableRequest.Options.TRUE = "true"

Definition at line 568 of file AlterTable.cs.

◆ UPDATE_LAST_ACCESS_TIME

const string kinetica.AlterTableRequest.Options.UPDATE_LAST_ACCESS_TIME = "update_last_access_time"

Indicates whether need to update the last_access_time.

Supported values:

The default value is TRUE.

Definition at line 585 of file AlterTable.cs.

◆ VALIDATE_CHANGE_COLUMN

const string kinetica.AlterTableRequest.Options.VALIDATE_CHANGE_COLUMN = "validate_change_column"

When changing a column, validate the change before applying it.

If true, then validate all values. A value too large (or too long) for the new type will prevent any change. If false, then when a value is too large or long, it will be truncated. Supported values:

The default value is TRUE.

Definition at line 567 of file AlterTable.cs.

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