A set of parameters for Kinetica.alterSchema. More...
Inheritance diagram for kinetica.AlterSchemaRequest:
Collaboration diagram for kinetica.AlterSchemaRequest:
Classes | |
| struct | Action |
| A set of string constants for the parameter action. More... | |
Public Member Functions | |
| AlterSchemaRequest () | |
| Constructs an AlterSchemaRequest object with default parameters. More... | |
| AlterSchemaRequest (string schema_name, string action, string _value, IDictionary< string, string > options=null) | |
| Constructs an AlterSchemaRequest 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 | schema_name [get, set] |
| Name of the schema to be altered. More... | |
| string | action [get, set] |
| Modification operation to be applied. More... | |
| string | _value [get, set] |
| The value of the modification, depending on action. More... | |
| IDictionary< string, string > | options = new Dictionary<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.alterSchema.
Used to change the name of a SQL-style schema, specified in schema_name.
Definition at line 17 of file AlterSchema.cs.
Constructor & Destructor Documentation
◆ AlterSchemaRequest() [1/2]
|
inline |
Constructs an AlterSchemaRequest object with default parameters.
Definition at line 72 of file AlterSchema.cs.
◆ AlterSchemaRequest() [2/2]
|
inline |
Constructs an AlterSchemaRequest object with the specified parameters.
- Parameters
-
schema_name Name of the schema to be altered. action Modification operation to be applied. Supported values: - ADD_COMMENT: Adds a comment describing the schema
- RENAME_SCHEMA: Renames a schema to _value . Has the same naming restrictions as tables.
_value The value of the modification, depending on action . For now the only value of action is RENAME_SCHEMA. In this case the value is the new name of the schema. options Optional parameters. The default value is an empty Dictionary.
Definition at line 103 of file AlterSchema.cs.
Property Documentation
◆ _value
|
getset |
The value of the modification, depending on action.
For now the only value of action is RENAME_SCHEMA. In this case the value is the new name of the schema.
Definition at line 63 of file AlterSchema.cs.
◆ action
|
getset |
Modification operation to be applied.
Supported values:
- ADD_COMMENT: Adds a comment describing the schema
- RENAME_SCHEMA: Renames a schema to _value. Has the same naming restrictions as tables.
Definition at line 56 of file AlterSchema.cs.
◆ options
|
getset |
Optional parameters.
The default value is an empty Dictionary.
Definition at line 68 of file AlterSchema.cs.
◆ schema_name
|
getset |
Name of the schema to be altered.
Definition at line 36 of file AlterSchema.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/AlterSchema.cs
