A set of parameters for Kinetica.alterTableColumns. More…
Public Member Functions | |
| AlterTableColumnsRequest () | |
| Constructs an AlterTableColumnsRequest object with default parameters. | |
| AlterTableColumnsRequest (string table_name, IList< IDictionary< string, string > > column_alterations, IDictionary< string, string > options) | |
| Constructs an AlterTableColumnsRequest object with the specified parameters. | |
| AlterTableColumnsRequest () | |
| Constructs an AlterTableColumnsRequest object with default parameters. | |
| AlterTableColumnsRequest (string table_name, IList< IDictionary< string, string > > column_alterations, IDictionary< string, string > options) | |
| Constructs an AlterTableColumnsRequest object with the specified parameters. | |
| Public Member Functions inherited from kinetica.KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
Properties | |
| string | table_name [get, set] |
| Table on which the operation will be performed. | |
| IList< IDictionary< string, string > > | column_alterations = new List<IDictionary<string, string>>() [get, set] |
| List of alter table add/delete/change column requests - all for the same table. | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Optional parameters. | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class. | |
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. | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. | |
Detailed Description
A set of parameters for Kinetica.alterTableColumns.
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, including whether it is dictionary encoded or not.
Definition at line 25 of file AlterTableColumns.cs.
Constructor & Destructor Documentation
◆ AlterTableColumnsRequest() [1/4]
| inline |
Constructs an AlterTableColumnsRequest object with default parameters.
Definition at line 49 of file AlterTableColumns.cs.
◆ AlterTableColumnsRequest() [2/4]
| inline |
Constructs an AlterTableColumnsRequest object with the specified parameters.
| table_name | Table on which the operation will be performed. Must be an existing table or view, in [schema_name.]table_name format, using standard name resolution rules. |
| 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 67 of file AlterTableColumns.cs.
◆ AlterTableColumnsRequest() [3/4]
| inline |
Constructs an AlterTableColumnsRequest object with default parameters.
Definition at line 49 of file AlterTableColumns.cs.
◆ AlterTableColumnsRequest() [4/4]
| inline |
Constructs an AlterTableColumnsRequest object with the specified parameters.
| table_name | Table on which the operation will be performed. Must be an existing table or view, in [schema_name.]table_name format, using standard name resolution rules. |
| 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 67 of file AlterTableColumns.cs.
Property Documentation
◆ 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 42 of file AlterTableColumns.cs.
◆ options
| getset |
Optional parameters.
Definition at line 45 of file AlterTableColumns.cs.
◆ table_name
| getset |
Table on which the operation will be performed.
Must be an existing table or view, in [schema_name.]table_name format, using standard name resolution rules.
Definition at line 32 of file AlterTableColumns.cs.
The documentation for this class was generated from the following files:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/AlterTableColumns.cs
- Kinetica/Protocol/AlterTableColumns.cs