kinetica.AlterTableColumnsRequest Class Reference

A set of parameters for Kinetica.alterTableColumns(string,IList{IDictionary{string, string}},IDictionary{string, string}). More...

Inheritance diagram for kinetica.AlterTableColumnsRequest:

Collaboration diagram for kinetica.AlterTableColumnsRequest:

Public Member Functions
	AlterTableColumnsRequest ()
	Constructs an AlterTableColumnsRequest object with default parameters. More...
	AlterTableColumnsRequest (string table_name, IList< IDictionary< string, string >> column_alterations, IDictionary< string, string > options)
	Constructs an AlterTableColumnsRequest 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...
IList< IDictionary< string, string > >	column_alterations [get, set]
	list of alter table add/delete/change column requests - all for the same table. More...
IDictionary< string, string >	options = new List<IDictionary<string, string>>() [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 Kinetica.alterTableColumns(string,IList{IDictionary{string, string}},IDictionary{string, string}).

Apply various modifications to columns in a table, view. The available modifications include the following:
Create or delete an index on a particular column. This can speed up certain operations when using expressions containing equality or relational operators on indexed columns. This only applies to tables.
Manage a table's columns–a column can be added, removed, or have its type and properties modified.
Set or unset compression for a column.

Definition at line 35 of file AlterTableColumns.cs.

Constructor & Destructor Documentation

kinetica.AlterTableColumnsRequest.AlterTableColumnsRequest ( )

inline

Constructs an AlterTableColumnsRequest object with default parameters.

Definition at line 61 of file AlterTableColumns.cs.

kinetica.AlterTableColumnsRequest.AlterTableColumnsRequest ( string  table_name, IList< IDictionary< string, string >>  column_alterations, IDictionary< string, string >  options  )

inline

Constructs an AlterTableColumnsRequest object with the specified parameters.

Parameters

table_name	Table on which the operation will be performed. Must be an existing table or view.
column_alterations	list of alter table add/delete/change column requests - all for the same table. each request is a map that includes 'column_name', 'action' and the options specific for the action, note that the same options as in alter table requests but in the same map as the column name and the action. For example: [{'column_name':'col_1','action':'change_column','rename_column':'col_2'}, {'column_name':'col_1','action':'add_column', 'type':'int','default_value':'1'} ]
options	Optional parameters.

Definition at line 81 of file AlterTableColumns.cs.

Property Documentation

IList<IDictionary<string, string> > kinetica.AlterTableColumnsRequest.column_alterations

getset

list of alter table add/delete/change column requests - all for the same table.

            each request is a map that includes 'column_name',

'action' and the options specific for the action, note that the same options as in alter table requests but in the same map as the column name and the action. For example: [{'column_name':'col_1','action':'change_column','rename_column':'col_2'}, {'column_name':'col_1','action':'add_column', 'type':'int','default_value':'1'} ]

Definition at line 53 of file AlterTableColumns.cs.

IDictionary<string, string> kinetica.AlterTableColumnsRequest.options = new List<IDictionary<string, string>>()

getset

Optional parameters.

Definition at line 56 of file AlterTableColumns.cs.

string kinetica.AlterTableColumnsRequest.table_name

getset

Table on which the operation will be performed.

Must be an existing table or view.

Definition at line 40 of file AlterTableColumns.cs.

---

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

• Kinetica/Protocol/AlterTableColumns.cs