Modification operation to be applied Supported values:

ALLOW_HOMOGENEOUS_TABLES: No longer supported; action will be ignored.

Public Attributes
const string	ALLOW_HOMOGENEOUS_TABLES = "allow_homogeneous_tables"
	No longer supported; action will be ignored. More...

const string	CREATE_INDEX = "create_index"
	Creates a column (attribute) index, chunk skip index, or geospatial index (depending on the specified index_type), on the column name specified in _value. More...

const string	DELETE_INDEX = "delete_index"
	Deletes a column (attribute) index, chunk skip index, or geospatial index (depending on the specified index_type), on the column name specified in _value. More...

const string	MOVE_TO_COLLECTION = "move_to_collection"
	[DEPRECATED–please use move_to_schema and use Kinetica.createSchema(string,IDictionary{string, string}) to create the schema if non-existent] Moves a table or view into a schema named _value. More...

const string	MOVE_TO_SCHEMA = "move_to_schema"
	Moves a table or view into a schema named _value. More...

const string	PROTECTED = "protected"
	No longer used. More...

const string	RENAME_TABLE = "rename_table"
	Renames a table or view within its current schema to _value. More...

const string	TTL = "ttl"
	Sets the time-to-live in minutes of the table or view specified in table_name. More...

const string	ADD_COLUMN = "add_column"
	Adds the column specified in _value to the table specified in table_name. More...

const string	CHANGE_COLUMN = "change_column"
	Changes type and properties of the column specified in _value. More...

const string	SET_COLUMN_COMPRESSION = "set_column_compression"
	No longer supported; action will be ignored. More...

const string	DELETE_COLUMN = "delete_column"
	Deletes the column specified in _value from the table specified in table_name. More...

const string	CREATE_FOREIGN_KEY = "create_foreign_key"
	Creates a foreign key specified in _value using the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'. More...

const string	DELETE_FOREIGN_KEY = "delete_foreign_key"
	Deletes a foreign key. More...

const string	ADD_PARTITION = "add_partition"
	Adds the partition specified in _value, to either a range-partitioned or manual list-partitioned table. More...

const string	REMOVE_PARTITION = "remove_partition"
	Removes the partition specified in _value (and relocates all of its data to the default partition) from either a range-partitioned or manual list-partitioned table. More...

const string	DELETE_PARTITION = "delete_partition"
	Deletes the partition specified in _value (and all of its data) from either a range-partitioned or manual list-partitioned table. More...

const string	SET_GLOBAL_ACCESS_MODE = "set_global_access_mode"
	Sets the global access mode (i.e. More...

const string	REFRESH = "refresh"
	For a materialized view, replays all the table creation commands required to create the view. More...

const string	SET_REFRESH_METHOD = "set_refresh_method"
	For a materialized view, sets the method by which the view is refreshed to the method specified in _value - one of 'manual', 'periodic', or 'on_change'. More...

const string	SET_REFRESH_START_TIME = "set_refresh_start_time"
	Sets the time to start periodic refreshes of this materialized view to the datetime string specified in _value with format 'YYYY-MM-DD HH:MM:SS'. More...

const string	SET_REFRESH_STOP_TIME = "set_refresh_stop_time"
	Sets the time to stop periodic refreshes of this materialized view to the datetime string specified in _value with format 'YYYY-MM-DD HH:MM:SS'. More...

const string	SET_REFRESH_PERIOD = "set_refresh_period"
	Sets the time interval in seconds at which to refresh this materialized view to the value specified in _value. More...

const string	SET_REFRESH_SPAN = "set_refresh_span"
	Sets the future time-offset(in seconds) for the view refresh to stop. More...

const string	SET_REFRESH_EXECUTE_AS = "set_refresh_execute_as"
	Sets the user name to refresh this materialized view to the value specified in _value. More...

const string	REMOVE_TEXT_SEARCH_ATTRIBUTES = "remove_text_search_attributes"
	Removes text search attribute from all columns. More...

const string	REMOVE_SHARD_KEYS = "remove_shard_keys"
	Removes the shard key property from all columns, so that the table will be considered randomly sharded. More...

const string	SET_STRATEGY_DEFINITION = "set_strategy_definition"
	Sets the tier strategy for the table and its columns to the one specified in _value, replacing the existing tier strategy in its entirety. More...

const string	CANCEL_DATASOURCE_SUBSCRIPTION = "cancel_datasource_subscription"
	Permanently unsubscribe a data source that is loading continuously as a stream. More...

const string	PAUSE_DATASOURCE_SUBSCRIPTION = "pause_datasource_subscription"
	Temporarily unsubscribe a data source that is loading continuously as a stream. More...

const string	RESUME_DATASOURCE_SUBSCRIPTION = "resume_datasource_subscription"
	Resubscribe to a paused data source subscription. More...

const string	CHANGE_OWNER = "change_owner"
	Change the owner resource group of the table. More...

Detailed Description

Modification operation to be applied Supported values:

ALLOW_HOMOGENEOUS_TABLES: No longer supported; action will be ignored.

CREATE_INDEX: Creates a column (attribute) index, chunk skip index, or geospatial index (depending on the specified index_type), on the column name specified in . If this column already has the specified index, an error will be returned. DELETE_INDEX: Deletes a column (attribute) index, chunk skip index, or geospatial index (depending on the specified index_type), on the column name specified in . If this column does not have the specified index, an error will be returned. MOVE_TO_COLLECTION: [DEPRECATED–please use move_to_schema and use /create/schema to create the schema if non-existent] Moves a table or view into a schema named . If the schema provided is non-existent, it will be automatically created. MOVE_TO_SCHEMA: Moves a table or view into a schema named . If the schema provided is nonexistent, an error will be thrown. If is empty, then the table or view will be placed in the user's default schema. PROTECTED: No longer used. Previously set whether the given should be protected or not. The would have been either 'true' or 'false'. RENAME_TABLE: Renames a table or view within its current schema to . Has the same naming restrictions as tables. TTL: Sets the time-to-live in minutes of the table or view specified in . ADD_COLUMN: Adds the column specified in to the table specified in . Use column_type and column_properties in to set the column's type and properties, respectively. CHANGE_COLUMN: Changes type and properties of the column specified in . Use column_type and column_properties in to set the column's type and properties, respectively. Note that primary key and/or shard key columns cannot be changed. All unchanging column properties must be listed for the change to take place, e.g., to add dictionary encoding to an existing 'char4' column, both 'char4' and 'dict' must be specified in the map. SET_COLUMN_COMPRESSION: No longer supported; action will be ignored. DELETE_COLUMN: Deletes the column specified in from the table specified in . CREATE_FOREIGN_KEY: Creates a foreign key specified in using the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'. DELETE_FOREIGN_KEY: Deletes a foreign key. The should be the foreign_key_name specified when creating the key or the complete string used to define it. ADD_PARTITION: Adds the partition specified in , to either a range-partitioned or manual list-partitioned table. REMOVE_PARTITION: Removes the partition specified in (and relocates all of its data to the default partition) from either a range-partitioned or manual list-partitioned table. DELETE_PARTITION: Deletes the partition specified in (and all of its data) from either a range-partitioned or manual list-partitioned table. SET_GLOBAL_ACCESS_MODE: Sets the global access mode (i.e. locking) for the table specified in . Specify the access mode in . Valid modes are 'no_access', 'read_only', 'write_only' and 'read_write'. REFRESH: For a materialized view, replays all the table creation commands required to create the view. For an external table, reloads all data in the table from its associated source files or data source. SET_REFRESH_METHOD: For a materialized view, sets the method by which the view is refreshed to the method specified in - one of 'manual', 'periodic', or 'on_change'. For an external table, sets the method by which the table is refreshed to the method specified in - either 'manual' or 'on_start'. SET_REFRESH_START_TIME: Sets the time to start periodic refreshes of this materialized view to the datetime string specified in with format 'YYYY-MM-DD HH:MM:SS'. Subsequent refreshes occur at the specified time + N * the refresh period. SET_REFRESH_STOP_TIME: Sets the time to stop periodic refreshes of this materialized view to the datetime string specified in with format 'YYYY-MM-DD HH:MM:SS'. SET_REFRESH_PERIOD: Sets the time interval in seconds at which to refresh this materialized view to the value specified in . Also, sets the refresh method to periodic if not already set. SET_REFRESH_SPAN: Sets the future time-offset(in seconds) for the view refresh to stop. SET_REFRESH_EXECUTE_AS: Sets the user name to refresh this materialized view to the value specified in . REMOVE_TEXT_SEARCH_ATTRIBUTES: Removes text search attribute from all columns. REMOVE_SHARD_KEYS: Removes the shard key property from all columns, so that the table will be considered randomly sharded. The data is not moved. The is ignored. SET_STRATEGY_DEFINITION: Sets the tier strategy for the table and its columns to the one specified in , replacing the existing tier strategy in its entirety. CANCEL_DATASOURCE_SUBSCRIPTION: Permanently unsubscribe a data source that is loading continuously as a stream. The data source can be Kafka / S3 / Azure. PAUSE_DATASOURCE_SUBSCRIPTION: Temporarily unsubscribe a data source that is loading continuously as a stream. The data source can be Kafka / S3 / Azure. RESUME_DATASOURCE_SUBSCRIPTION: Resubscribe to a paused data source subscription. The data source can be Kafka / S3 / Azure. CHANGE_OWNER: Change the owner resource group of the table.

A set of string constants for the parameter action.

Definition at line 378 of file AlterTable.cs.

Member Data Documentation

const string kinetica.AlterTableRequest.Action.ADD_COLUMN = "add_column"

Adds the column specified in _value to the table specified in table_name.

Use column_type and column_properties in options to set the column's type and properties, respectively.

Definition at line 449 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.ADD_PARTITION = "add_partition"

Adds the partition specified in _value, to either a range-partitioned or manual list-partitioned table.

Definition at line 492 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.ALLOW_HOMOGENEOUS_TABLES = "allow_homogeneous_tables"

No longer supported; action will be ignored.

Definition at line 382 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.CANCEL_DATASOURCE_SUBSCRIPTION = "cancel_datasource_subscription"

Permanently unsubscribe a data source that is loading continuously as a stream.

The data source can be Kafka / S3 / Azure.

Definition at line 590 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.CHANGE_COLUMN = "change_column"

Changes type and properties of the column specified in _value.

Use column_type and column_properties in options to set the column's type and properties, respectively. Note that primary key and/or shard key columns cannot be changed. All unchanging column properties must be listed for the change to take place, e.g., to add dictionary encoding to an existing 'char4' column, both 'char4' and 'dict' must be specified in the options map.

Definition at line 461 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.CHANGE_OWNER = "change_owner"

Change the owner resource group of the table.

Definition at line 603 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.CREATE_FOREIGN_KEY = "create_foreign_key"

Creates a foreign key specified in _value using the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'.

Definition at line 477 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.CREATE_INDEX = "create_index"

Creates a column (attribute) index, chunk skip index, or geospatial index (depending on the specified index_type), on the column name specified in _value.

If this column already has the specified index, an error will be returned.

Definition at line 395 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.DELETE_COLUMN = "delete_column"

Deletes the column specified in _value from the table specified in table_name.

Definition at line 469 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.DELETE_FOREIGN_KEY = "delete_foreign_key"

Deletes a foreign key.

The _value should be the foreign_key_name specified when creating the key or the complete string used to define it.

Definition at line 484 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.DELETE_INDEX = "delete_index"

Deletes a column (attribute) index, chunk skip index, or geospatial index (depending on the specified index_type), on the column name specified in _value.

If this column does not have the specified index, an error will be returned.

Definition at line 408 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.DELETE_PARTITION = "delete_partition"

Deletes the partition specified in _value (and all of its data) from either a range-partitioned or manual list-partitioned table.

Definition at line 509 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.MOVE_TO_COLLECTION = "move_to_collection"

[DEPRECATED–please use move_to_schema and use Kinetica.createSchema(string,IDictionary{string, string}) to create the schema if non-existent] Moves a table or view into a schema named _value.

If the schema provided is non-existent, it will be automatically created.

Definition at line 417 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.MOVE_TO_SCHEMA = "move_to_schema"

Moves a table or view into a schema named _value.

If the schema provided is nonexistent, an error will be thrown. If _value is empty, then the table or view will be placed in the user's default schema.

Definition at line 424 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.PAUSE_DATASOURCE_SUBSCRIPTION = "pause_datasource_subscription"

Temporarily unsubscribe a data source that is loading continuously as a stream.

The data source can be Kafka / S3 / Azure.

Definition at line 595 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.PROTECTED = "protected"

No longer used.

Previously set whether the given table_name should be protected or not. The _value would have been either 'true' or 'false'.

Definition at line 430 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.REFRESH = "refresh"

For a materialized view, replays all the table creation commands required to create the view.

For an external table, reloads all data in the table from its associated source files or data source.

Definition at line 526 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.REMOVE_PARTITION = "remove_partition"

Removes the partition specified in _value (and relocates all of its data to the default partition) from either a range-partitioned or manual list-partitioned table.

Definition at line 501 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.REMOVE_SHARD_KEYS = "remove_shard_keys"

Removes the shard key property from all columns, so that the table will be considered randomly sharded.

The data is not moved. The _value is ignored.

Definition at line 578 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.REMOVE_TEXT_SEARCH_ATTRIBUTES = "remove_text_search_attributes"

Removes text search attribute from all columns.

Definition at line 573 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.RENAME_TABLE = "rename_table"

Renames a table or view within its current schema to _value.

Has the same naming restrictions as tables.

Definition at line 436 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.RESUME_DATASOURCE_SUBSCRIPTION = "resume_datasource_subscription"

Resubscribe to a paused data source subscription.

The data source can be Kafka / S3 / Azure.

Definition at line 599 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.SET_COLUMN_COMPRESSION = "set_column_compression"

No longer supported; action will be ignored.

Definition at line 464 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.SET_GLOBAL_ACCESS_MODE = "set_global_access_mode"

Sets the global access mode (i.e.

locking) for the table specified in table_name. Specify the access mode in _value. Valid modes are 'no_access', 'read_only', 'write_only' and 'read_write'.

Definition at line 516 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.SET_REFRESH_EXECUTE_AS = "set_refresh_execute_as"

Sets the user name to refresh this materialized view to the value specified in _value.

Definition at line 568 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.SET_REFRESH_METHOD = "set_refresh_method"

For a materialized view, sets the method by which the view is refreshed to the method specified in _value - one of 'manual', 'periodic', or 'on_change'.

For an external table, sets the method by which the table is refreshed to the method specified in _value - either 'manual' or 'on_start'.

Definition at line 536 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.SET_REFRESH_PERIOD = "set_refresh_period"

Sets the time interval in seconds at which to refresh this materialized view to the value specified in _value.

Also, sets the refresh method to periodic if not already set.

Definition at line 558 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.SET_REFRESH_SPAN = "set_refresh_span"

Sets the future time-offset(in seconds) for the view refresh to stop.

Definition at line 562 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.SET_REFRESH_START_TIME = "set_refresh_start_time"

Sets the time to start periodic refreshes of this materialized view to the datetime string specified in _value with format 'YYYY-MM-DD HH:MM:SS'.

Subsequent refreshes occur at the specified time + N * the refresh period.

Definition at line 544 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.SET_REFRESH_STOP_TIME = "set_refresh_stop_time"

Sets the time to stop periodic refreshes of this materialized view to the datetime string specified in _value with format 'YYYY-MM-DD HH:MM:SS'.

Definition at line 551 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.SET_STRATEGY_DEFINITION = "set_strategy_definition"

Sets the tier strategy for the table and its columns to the one specified in _value, replacing the existing tier strategy in its entirety.

Definition at line 585 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.TTL = "ttl"

Sets the time-to-live in minutes of the table or view specified in table_name.

Definition at line 441 of file AlterTable.cs.

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

Kinetica/Protocol/AlterTable.cs

Public Attributes

Detailed Description

Member Data Documentation