Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.AlterSchemaRequest Class Reference

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

+ Inheritance diagram for kinetica.AlterSchemaRequest:
+ Collaboration diagram for kinetica.AlterSchemaRequest:

Classes

struct  Action
 Modification operation to be applied Supported values:

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 Supported values:

More...
 
string _value [get, set]
 The value of the modification, depending on . 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 Kinetica.alterSchema(string,string,string,IDictionary{string, string}).


Used to change the name of a SQL-style schema, specified in schema_name.

Definition at line 21 of file AlterSchema.cs.

Constructor & Destructor Documentation

kinetica.AlterSchemaRequest.AlterSchemaRequest ( )
inline

Constructs an AlterSchemaRequest object with default parameters.

Definition at line 79 of file AlterSchema.cs.

kinetica.AlterSchemaRequest.AlterSchemaRequest ( string  schema_name,
string  action,
string  _value,
IDictionary< string, string >  options = null 
)
inline

Constructs an AlterSchemaRequest object with the specified parameters.

Parameters
schema_nameName of the schema to be altered.
actionModification operation to be applied Supported values:
_valueThe value of the modification, depending on . For now the only value of is rename_schema. In this case the value is the new name of the schema.
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 106 of file AlterSchema.cs.

Property Documentation

string kinetica.AlterSchemaRequest._value
getset

The value of the modification, depending on .

For now the only value of is rename_schema. In this case the value is the new name of the schema.

Definition at line 70 of file AlterSchema.cs.

string kinetica.AlterSchemaRequest.action
getset

Modification operation to be applied Supported values:

Has the same naming restrictions as tables.

Definition at line 63 of file AlterSchema.cs.

IDictionary<string, string> kinetica.AlterSchemaRequest.options
getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 74 of file AlterSchema.cs.

string kinetica.AlterSchemaRequest.schema_name
getset

Name of the schema to be altered.

Definition at line 49 of file AlterSchema.cs.


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