Kinetica C# API  Version 6.0.1.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.AlterTableRequest.Action Struct Reference

Modification operation to be applied Values: create_index, delete_index, allow_homogeneous_tables, protected, ttl, add_column, delete_column, change_column, rename_table. More...

Public Attributes

const string CREATE_INDEX = "create_index"
 Creates an index on the column name specified in <member name="_value">. More...
 
const string DELETE_INDEX = "delete_index"
 Deletes an existing index on the column name specified in <member name="_value">. More...
 
const string ALLOW_HOMOGENEOUS_TABLES = "allow_homogeneous_tables"
 Sets whether homogeneous tables are allowed in the given collection. More...
 
const string PROTECTED = "protected"
 Sets whether the given <member name="table_name"> should be protected or not. More...
 
const string TTL = "ttl"
 Sets the TTL of the table, view, or collection specified in <member name="table_name">. More...
 
const string ADD_COLUMN = "add_column"
 Add a column <member name="_value"> to the table. More...
 
const string DELETE_COLUMN = "delete_column"
 Delete a column <member name="_value"> from the table More...
 
const string CHANGE_COLUMN = "change_column"
 Change properties of a column <member name="_value"> in the table. More...
 
const string RENAME_TABLE = "rename_table"
 Rename a table, view or collection to <member name="_value">. More...
 

Detailed Description

Modification operation to be applied Values: create_index, delete_index, allow_homogeneous_tables, protected, ttl, add_column, delete_column, change_column, rename_table.


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

Definition at line 46 of file AlterTable.cs.

Member Data Documentation

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

Add a column <member name="_value"> to the table.

set the column properties in options

Definition at line 77 of file AlterTable.cs.

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

Sets whether homogeneous tables are allowed in the given collection.

This action is only valid if <member name="table_name"> is a collection. The <member name="_value"> must be either 'true' or 'false'.

Definition at line 63 of file AlterTable.cs.

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

Change properties of a column <member name="_value"> in the table.

set the column properties in options

Definition at line 85 of file AlterTable.cs.

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

Creates an index on the column name specified in <member name="_value">.

If this column is already indexed, an error will be returned.

Definition at line 52 of file AlterTable.cs.

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

Delete a column <member name="_value"> from the table

Definition at line 81 of file AlterTable.cs.

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

Deletes an existing index on the column name specified in <member name="_value">.

If this column does not have indexing turned on, an error will be returned.

Definition at line 57 of file AlterTable.cs.

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

Sets whether the given <member name="table_name"> should be protected or not.

The <member name="_value"> must be either 'true' or 'false'.

Definition at line 68 of file AlterTable.cs.

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

Rename a table, view or collection to <member name="_value">.

Has the same naming restrictions as tables.

Definition at line 91 of file AlterTable.cs.

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

Sets the TTL of the table, view, or collection specified in <member name="table_name">.

The <member name="_value"> must be the desired TTL in minutes.

Definition at line 73 of file AlterTable.cs.


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