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

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

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

Classes

struct  Options
 Optional parameters. More...
 

Public Member Functions

 DropSchemaRequest ()
 Constructs a DropSchemaRequest object with default parameters. More...
 
 DropSchemaRequest (string schema_name, IDictionary< string, string > options=null)
 Constructs a DropSchemaRequest 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 dropped. 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.dropSchema(string,IDictionary{string, string}).


Drops an existing SQL-style schema, specified in schema_name.

Definition at line 20 of file DropSchema.cs.

Constructor & Destructor Documentation

kinetica.DropSchemaRequest.DropSchemaRequest ( )
inline

Constructs a DropSchemaRequest object with default parameters.

Definition at line 171 of file DropSchema.cs.

kinetica.DropSchemaRequest.DropSchemaRequest ( string  schema_name,
IDictionary< string, string >  options = null 
)
inline

Constructs a DropSchemaRequest object with the specified parameters.

Parameters
schema_nameName of the schema to be dropped. Must be an existing schema.
optionsOptional parameters.
  • NO_ERROR_IF_NOT_EXISTS: If true and if the schema specified in does not exist, no error is returned. If false and if the schema specified in does not exist, then an error is returned. Supported values: The default value is FALSE.
  • CASCADE: If true, all tables within the schema will be dropped. If false, the schema will be dropped only if empty. Supported values: The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 225 of file DropSchema.cs.

Property Documentation

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

Optional parameters.

  • NO_ERROR_IF_NOT_EXISTS: If true and if the schema specified in does not exist, no error is returned. If false and if the schema specified in does not exist, then an error is returned. Supported values: The default value is FALSE.
  • CASCADE: If true, all tables within the schema will be dropped. If false, the schema will be dropped only if empty. Supported values: The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 166 of file DropSchema.cs.

string kinetica.DropSchemaRequest.schema_name
getset

Name of the schema to be dropped.

Must be an existing schema.

Definition at line 118 of file DropSchema.cs.


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