A set of parameters for /alter/table. More...

Inheritance diagram for kinetica.AlterTableRequest:

Collaboration diagram for kinetica.AlterTableRequest:

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

struct	Options
	Optional parameters. More...

Public Member Functions
	AlterTableRequest ()
	Constructs an AlterTableRequest object with default parameters. More...

	AlterTableRequest (string table_name, string action, string _value, IDictionary< string, string > options=null)
	Constructs an AlterTableRequest object with the specified parameters. More...

Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...

object	Get (int fieldPos)
	Retrieve a specific property from this object More...

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
string	table_name `[get, set]`
	Table on which the operation will be performed. More...

string	action `[get, set]`
	Modification operation to be applied Values: create_index, delete_index, allow_homogeneous_tables, protected, ttl, add_column, delete_column, change_column, rename_table. More...

string	_value `[get, set]`
	The value of the modification. More...

IDictionary< string, string >	options `[get, set]`
	Optional parameters. More...

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

Additional Inherited Members
Static Public Member Functions inherited from kinetica.KineticaData
static RecordSchema	SchemaFromType (System.Type t, KineticaType ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType. More...

Detailed Description

A set of parameters for /alter/table.

Apply various modifications to a table or collection. Available modifications include:
Creating or deleting an index on a particular column. This can speed up certain search queries (such as /get/records, /delete/records, /update/records) when using expressions containing equality or relational operators on indexed columns. This only applies to tables.
Setting the time-to-live (TTL). This can be applied to tables, views, or collections. When applied to collections, every table & view within the collection will have its TTL set to the given value.
Making a table protected or not. Protected tables have their TTLs set to not automatically expire. This can be applied to tables, views, and collections.
Allowing homogeneous tables within a collection.
Managing a table's columns–a column can be added or removed, or have its type modified.

Definition at line 37 of file AlterTable.cs.

Constructor & Destructor Documentation

kinetica.AlterTableRequest.AlterTableRequest ( )

inline

Constructs an AlterTableRequest object with default parameters.

Definition at line 227 of file AlterTable.cs.

kinetica.AlterTableRequest.AlterTableRequest	(	string	table_name,
		string	action,
		string	_value,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs an AlterTableRequest object with the specified parameters.

Parameters

table_name	Table on which the operation will be performed. Must be an existing table, view, or collection.
action	Modification operation to be applied Values: create_index, delete_index, allow_homogeneous_tables, protected, ttl, add_column, delete_column, change_column, rename_table.
_value	The value of the modification. May be a column name, 'true' or 'false', or a TTL depending on .
options	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.

Definition at line 279 of file AlterTable.cs.

Property Documentation

string kinetica.AlterTableRequest._value

getset

The value of the modification.

May be a column name, 'true' or 'false', or a TTL depending on .

Definition at line 184 of file AlterTable.cs.

string kinetica.AlterTableRequest.action

getset

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

Definition at line 179 of file AlterTable.cs.

IDictionary<string, string> kinetica.AlterTableRequest.options

getset

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.

Definition at line 222 of file AlterTable.cs.

string kinetica.AlterTableRequest.table_name

getset

Table on which the operation will be performed.

Must be an existing table, view, or collection.

Definition at line 173 of file AlterTable.cs.

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

Kinetica/Protocol/AlterTable.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Property Documentation