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

Public Attributes
const string	ACTION = "action"

const string	COLUMN_NAME = "column_name"

const string	TABLE_NAME = "table_name"

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, 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	COPY_VALUES_FROM_COLUMN = "copy_values_from_column"
	[DEPRECATED–please use 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 (or not). More...

const string	TRUE = "true"
	Reset the expiration countdown timer to the table's configured TTL. More...

const string	FALSE = "false"
	Don't reset the timer; expiration countdown will continue from where it is, as if the table had not been accessed. More...

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

const string	ADD_COLUMN_EXPRESSION = "add_column_expression"
	When adding a column, an optional expression to use for the new column's values. More...

const string	STRATEGY_DEFINITION = "strategy_definition"
	Optional parameter for specifying the tier strategy for the table and its columns when action is SET_STRATEGY_DEFINITION, replacing the existing tier strategy in its entirety. More...

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

const string	COLUMN = "column"
	Create or delete a column (attribute) index. More...

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

const string	CHUNK_SKIP = "chunk_skip"
	Create or delete a chunk skip index. More...

const string	GEOSPATIAL = "geospatial"
	Create or delete a geospatial index More...

const string	CAGRA = "cagra"
	Create or delete a CAGRA index on a vector column More...

const string	HNSW = "hnsw"
	Create or delete an HNSW index on a vector column More...

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

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 352 of file AlterTable.cs.

Member Data Documentation

◆ ACTION

const string kinetica.AlterTableRequest.Options.ACTION = "action"

Definition at line 354 of file AlterTable.cs.

◆ ADD_COLUMN_EXPRESSION

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

When adding a column, an optional expression to use for the new column's values.

Any valid expression may be used, including one containing references to existing columns in the same table.

Definition at line 438 of file AlterTable.cs.

◆ CAGRA

const string kinetica.AlterTableRequest.Options.CAGRA = "cagra"

Create or delete a CAGRA index on a vector column

Definition at line 533 of file AlterTable.cs.

◆ CHUNK_SKIP

const string kinetica.AlterTableRequest.Options.CHUNK_SKIP = "chunk_skip"

Create or delete a chunk skip index.

Definition at line 521 of file AlterTable.cs.

◆ COLUMN

const string kinetica.AlterTableRequest.Options.COLUMN = "column"

Create or delete a column (attribute) index.

Definition at line 510 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 362 of file AlterTable.cs.

◆ COLUMN_NAME

const string kinetica.AlterTableRequest.Options.COLUMN_NAME = "column_name"

Definition at line 355 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, text_search, char8, int8 etc).

Definition at line 367 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 372 of file AlterTable.cs.

◆ COPY_VALUES_FROM_COLUMN

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

[DEPRECATED–please use ADD_COLUMN_EXPRESSION instead.

]

Definition at line 377 of file AlterTable.cs.

◆ FALSE

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

Don't reset the timer; expiration countdown will continue from where it is, as if the table had not been accessed.

Definition at line 410 of file AlterTable.cs.

◆ GEOSPATIAL

const string kinetica.AlterTableRequest.Options.GEOSPATIAL = "geospatial"

Create or delete a geospatial index

Definition at line 526 of file AlterTable.cs.

◆ HNSW

const string kinetica.AlterTableRequest.Options.HNSW = "hnsw"

Create or delete an HNSW index on a vector column

Definition at line 539 of file AlterTable.cs.

◆ INDEX_OPTIONS

const string kinetica.AlterTableRequest.Options.INDEX_OPTIONS = "index_options"

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

Valid options vary by index type.

Definition at line 545 of file AlterTable.cs.

◆ INDEX_TYPE

const string kinetica.AlterTableRequest.Options.INDEX_TYPE = "index_type"

Type of index to create, when action is CREATE_INDEX; to refresh, when action is REFRESH_INDEX; or to delete, when 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 505 of file AlterTable.cs.

◆ LOW_CARDINALITY

const string kinetica.AlterTableRequest.Options.LOW_CARDINALITY = "low_cardinality"

Create a low-cardinality column (attribute) index.

Definition at line 516 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 381 of file AlterTable.cs.

◆ STRATEGY_DEFINITION

const string kinetica.AlterTableRequest.Options.STRATEGY_DEFINITION = "strategy_definition"

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

Definition at line 446 of file AlterTable.cs.

◆ TABLE_NAME

const string kinetica.AlterTableRequest.Options.TABLE_NAME = "table_name"

Definition at line 356 of file AlterTable.cs.

◆ TRUE

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

Reset the expiration countdown timer to the table's configured TTL.

Definition at line 405 of file AlterTable.cs.

◆ UPDATE_LAST_ACCESS_TIME

const string kinetica.AlterTableRequest.Options.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.

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 431 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 (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 401 of file AlterTable.cs.

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

_build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/AlterTable.cs

Public Attributes

Detailed Description

Member Data Documentation

◆ ACTION

◆ ADD_COLUMN_EXPRESSION

◆ 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