Kinetica C# API  Version 6.0.1.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
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 data. 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 VALIDATE_CHANGE_COLUMN = "validate_change_column"
 Validate the type change before applying column_change request. More...
 
const string TRUE = "true"
 true More...
 
const string FALSE = "false"
 false More...
 
const string COPY_VALUES_FROM_COLUMN = "copy_values_from_column"
 when adding or changing a column: enter column name - from where to copy values. More...
 

Detailed Description

Optional parameters.

  • column_default_value when adding a column: set a default value, for existing data.
  • 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).
  • validate_change_column Validate the type change before applying column_change request. Default is true (if option is missing). 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. Values: true, false.
  • copy_values_from_column when adding or changing a column: enter column name - from where to copy values.


A set of string constants for the parameter <member name="options">.

Definition at line 133 of file AlterTable.cs.

Member Data Documentation

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

when adding a column: set a default value, for existing data.

Definition at line 138 of file AlterTable.cs.

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 143 of file AlterTable.cs.

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 148 of file AlterTable.cs.

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

when adding or changing a column: enter column name - from where to copy values.

Definition at line 167 of file AlterTable.cs.

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

false

Definition at line 163 of file AlterTable.cs.

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

true

Definition at line 160 of file AlterTable.cs.

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

Validate the type change before applying column_change request.

Default is true (if option is missing). 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. Values: true, false.

Definition at line 157 of file AlterTable.cs.

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