kinetica.AlterTableRequest.Options

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

Static Public Attributes
const string	ACTION = “action”
	A constant for the AlterTableRequest.Options options.

const string	COLUMN_NAME = “column_name”
	A constant for the AlterTableRequest.Options options.

const string	TABLE_NAME = “table_name”
	A constant for the AlterTableRequest.Options options.

const string	COLUMN_DEFAULT_VALUE = “column_default_value”
	When adding a column, set a literal default value for existing records.

const string	COLUMN_PROPERTIES = “column_properties”
	When adding or changing a column, set the column properties (strings, separated by a comma: data, text_search, char8, int8 etc).

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

const string	COPY_VALUES_FROM_COLUMN = “copy_values_from_column”
	[DEPRECATED] Please use ADD_COLUMN_EXPRESSION instead.

const string	RENAME_COLUMN = “rename_column”
	When changing a column, specify new column name.

const string	VALIDATE_CHANGE_COLUMN = “validate_change_column”
	When changing a column, validate the change before applying it (or not).

const string	TRUE = “true”
	A boolean constant for the AlterTableRequest.Options options.

const string	FALSE = “false”
	A boolean constant for the AlterTableRequest.Options options.

const string	UPDATE_LAST_ACCESS_TIME = “update_last_access_time”
	Indicates whether the time-to-live (TTL) expiration countdown timer should be reset to the table’s TTL.

const string	ADD_COLUMN_EXPRESSION = “add_column_expression”
	When adding a column or setting a new default with AlterTableRequest.action set to SET_DEFAULT, the new default expression (GPUdb-syntax) for the column.

const string	ADD_COLUMN_EXPRESSION_SQL = “add_column_expression_sql”
	Optional SQL-syntax form of ADD_COLUMN_EXPRESSION, used only when the SQL syntax differs from the GPUdb syntax.

const string	STRATEGY_DEFINITION = “strategy_definition”
	Parameter for specifying the tier strategy for the table and its columns when AlterTableRequest.action is SET_STRATEGY_DEFINITION, replacing the existing tier strategy in its entirety.

const string	INDEX_TYPE = “index_type”
	Type of index to create, when AlterTableRequest.action is CREATE_INDEX; to refresh, when AlterTableRequest.action is REFRESH_INDEX; or to delete, when AlterTableRequest.action is DELETE_INDEX.

const string	COLUMN = “column”
	Create or delete a column (attribute) index.

const string	LOW_CARDINALITY = “low_cardinality”
	Create a low-cardinality column (attribute) index.

const string	CHUNK_SKIP = “chunk_skip”
	Create or delete a chunk skip index.

const string	GEOSPATIAL = “geospatial”
	Create or delete a geospatial index.

const string	CAGRA = “cagra”
	Create or delete a CAGRA index on a vector column.

const string	HNSW = “hnsw”
	Create or delete an HNSW index on a vector column.

const string	INDEX_OPTIONS = “index_options”
	Options to use when creating an index, in the format “key: value [, key: value [, …]]”.

Detailed Description

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

Optional parameters.

Definition at line 381 of file AlterTable.cs.

Member Data Documentation

◆ ACTION

const string kinetica.AlterTableRequest.Options.ACTION = “action”

static

A constant for the AlterTableRequest.Options options.

Definition at line 385 of file AlterTable.cs.

◆ ADD_COLUMN_EXPRESSION

const string kinetica.AlterTableRequest.Options.ADD_COLUMN_EXPRESSION = “add_column_expression”

static

When adding a column or setting a new default with AlterTableRequest.action set to SET_DEFAULT, the new default expression (GPUdb-syntax) for the column.

Any valid expression may be used, including one containing references to existing columns in the same table. Persisted as the column’s default for future inserts that omit the column; for add_column, also used to backfill existing rows.

Definition at line 482 of file AlterTable.cs.

◆ ADD_COLUMN_EXPRESSION_SQL

const string kinetica.AlterTableRequest.Options.ADD_COLUMN_EXPRESSION_SQL = “add_column_expression_sql”

static

Optional SQL-syntax form of ADD_COLUMN_EXPRESSION, used only when the SQL syntax differs from the GPUdb syntax.

Persisted alongside the GPUdb form so SHOW CREATE TABLE / information_schema can reproduce the original SQL.

Definition at line 491 of file AlterTable.cs.

◆ CAGRA

const string kinetica.AlterTableRequest.Options.CAGRA = “cagra”

static

Create or delete a CAGRA index on a vector column.

Definition at line 593 of file AlterTable.cs.

◆ CHUNK_SKIP

const string kinetica.AlterTableRequest.Options.CHUNK_SKIP = “chunk_skip”

static

Create or delete a chunk skip index.

Definition at line 582 of file AlterTable.cs.

◆ COLUMN

const string kinetica.AlterTableRequest.Options.COLUMN = “column”

static

Create or delete a column (attribute) index.

Definition at line 571 of file AlterTable.cs.

◆ COLUMN_DEFAULT_VALUE

const string kinetica.AlterTableRequest.Options.COLUMN_DEFAULT_VALUE = “column_default_value”

static

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

For nullable columns, the default value will be null, regardless of data type. Also persisted as the column’s default for future inserts that omit the column.

Definition at line 400 of file AlterTable.cs.

◆ COLUMN_NAME

const string kinetica.AlterTableRequest.Options.COLUMN_NAME = “column_name”

static

A constant for the AlterTableRequest.Options options.

Definition at line 389 of file AlterTable.cs.

◆ COLUMN_PROPERTIES

const string kinetica.AlterTableRequest.Options.COLUMN_PROPERTIES = “column_properties”

static

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

Definition at line 405 of file AlterTable.cs.

◆ COLUMN_TYPE

const string kinetica.AlterTableRequest.Options.COLUMN_TYPE = “column_type”

static

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

Definition at line 410 of file AlterTable.cs.

◆ COPY_VALUES_FROM_COLUMN

const string kinetica.AlterTableRequest.Options.COPY_VALUES_FROM_COLUMN = “copy_values_from_column”

static

[DEPRECATED] Please use ADD_COLUMN_EXPRESSION instead.

Definition at line 415 of file AlterTable.cs.

◆ FALSE

const string kinetica.AlterTableRequest.Options.FALSE = “false”

static

A boolean constant for the AlterTableRequest.Options options.

Definition at line 448 of file AlterTable.cs.

◆ GEOSPATIAL

const string kinetica.AlterTableRequest.Options.GEOSPATIAL = “geospatial”

static

Create or delete a geospatial index.

Definition at line 587 of file AlterTable.cs.

◆ HNSW

const string kinetica.AlterTableRequest.Options.HNSW = “hnsw”

static

Create or delete an HNSW index on a vector column.

Definition at line 599 of file AlterTable.cs.

◆ INDEX_OPTIONS

const string kinetica.AlterTableRequest.Options.INDEX_OPTIONS = “index_options”

static

Options to use when creating an index, in the format “key: value [, key: value [, …]]”.

Valid options vary by index type.

Definition at line 604 of file AlterTable.cs.

◆ INDEX_TYPE

const string kinetica.AlterTableRequest.Options.INDEX_TYPE = “index_type”

static

Type of index to create, when AlterTableRequest.action is CREATE_INDEX; to refresh, when AlterTableRequest.action is REFRESH_INDEX; or to delete, when AlterTableRequest.action is DELETE_INDEX.

Supported values:

COLUMN: Create or delete a column (attribute) index.
LOW_CARDINALITY: Create a low-cardinality column (attribute) index.
CHUNK_SKIP: Create or delete a chunk skip index.
GEOSPATIAL: Create or delete a geospatial index.
CAGRA: Create or delete a CAGRA index on a vector column.
HNSW: Create or delete an HNSW index on a vector column.

The default value is COLUMN.

Definition at line 566 of file AlterTable.cs.

◆ LOW_CARDINALITY

const string kinetica.AlterTableRequest.Options.LOW_CARDINALITY = “low_cardinality”

static

Create a low-cardinality column (attribute) index.

Definition at line 577 of file AlterTable.cs.

◆ RENAME_COLUMN

const string kinetica.AlterTableRequest.Options.RENAME_COLUMN = “rename_column”

static

When changing a column, specify new column name.

Definition at line 418 of file AlterTable.cs.

◆ STRATEGY_DEFINITION

const string kinetica.AlterTableRequest.Options.STRATEGY_DEFINITION = “strategy_definition”

static

Parameter for specifying the tier strategy for the table and its columns when AlterTableRequest.action is SET_STRATEGY_DEFINITION, replacing the existing tier strategy in its entirety.

Definition at line 499 of file AlterTable.cs.

◆ TABLE_NAME

const string kinetica.AlterTableRequest.Options.TABLE_NAME = “table_name”

static

A constant for the AlterTableRequest.Options options.

Definition at line 393 of file AlterTable.cs.

◆ TRUE

const string kinetica.AlterTableRequest.Options.TRUE = “true”

static

A boolean constant for the AlterTableRequest.Options options.

Definition at line 444 of file AlterTable.cs.

◆ UPDATE_LAST_ACCESS_TIME

const string kinetica.AlterTableRequest.Options.UPDATE_LAST_ACCESS_TIME = “update_last_access_time”

static

Indicates whether the time-to-live (TTL) expiration countdown timer should be reset to the table’s TTL.

Supported values:

TRUE: Reset the expiration countdown timer to the table’s configured TTL.
FALSE: Don’t reset the timer; expiration countdown will continue from where it is, as if the table had not been accessed.

The default value is TRUE.

Definition at line 471 of file AlterTable.cs.

◆ VALIDATE_CHANGE_COLUMN

const string kinetica.AlterTableRequest.Options.VALIDATE_CHANGE_COLUMN = “validate_change_column”

static

When changing a column, validate the change before applying it (or not).

Supported values:

TRUE: Validate all values. A value too large (or too long) for the new type will prevent any change.
FALSE: When a value is too large or long, it will be truncated.

The default value is TRUE.

Definition at line 440 of file AlterTable.cs.

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

_build/public-os_centos8-arch_amd64-cc_gcc_8.5.0/install/Kinetica/Protocol/AlterTable.cs
Kinetica/Protocol/AlterTable.cs

​ Static Public Attributes

​Detailed Description

​Member Data Documentation

​◆ ACTION

​◆ ADD_COLUMN_EXPRESSION

​◆ ADD_COLUMN_EXPRESSION_SQL

​◆ CAGRA

​◆ CHUNK_SKIP

​◆ COLUMN

​◆ COLUMN_DEFAULT_VALUE

​◆ COLUMN_NAME

​◆ COLUMN_PROPERTIES

​◆ COLUMN_TYPE

​◆ COPY_VALUES_FROM_COLUMN

​◆ FALSE

​◆ GEOSPATIAL

​◆ HNSW

​◆ INDEX_OPTIONS

​◆ INDEX_TYPE

​◆ LOW_CARDINALITY

​◆ RENAME_COLUMN

​◆ STRATEGY_DEFINITION

​◆ TABLE_NAME

​◆ TRUE

​◆ UPDATE_LAST_ACCESS_TIME

​◆ VALIDATE_CHANGE_COLUMN

Static Public Attributes

Detailed Description

Member Data Documentation

◆ ACTION

◆ ADD_COLUMN_EXPRESSION

◆ ADD_COLUMN_EXPRESSION_SQL

◆ CAGRA

◆ CHUNK_SKIP

◆ COLUMN

◆ COLUMN_DEFAULT_VALUE

◆ COLUMN_NAME

◆ COLUMN_PROPERTIES

◆ COLUMN_TYPE

◆ COPY_VALUES_FROM_COLUMN

◆ FALSE

◆ GEOSPATIAL

◆ HNSW

◆ INDEX_OPTIONS

◆ INDEX_TYPE

◆ LOW_CARDINALITY

◆ RENAME_COLUMN

◆ STRATEGY_DEFINITION

◆ TABLE_NAME

◆ TRUE

◆ UPDATE_LAST_ACCESS_TIME

◆ VALIDATE_CHANGE_COLUMN