kinetica.DropSchemaRequest Class Reference
A set of parameters for Kinetica.dropSchema. More...
Inheritance diagram for kinetica.DropSchemaRequest:
Collaboration diagram for kinetica.DropSchemaRequest:
Classes | |
| struct | Options |
| A set of string constants for the parameter options. 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... | |
| 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... | |
| 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 = new Dictionary<string, string>() [get, set] |
| Optional parameters. More... | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class More... | |
| Properties inherited from Avro.Specific.ISpecificRecord | |
| Schema | Schema [get] |
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... | |
| 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.
Drops an existing SQL-style schema, specified in schema_name.
Definition at line 17 of file DropSchema.cs.
Constructor & Destructor Documentation
◆ DropSchemaRequest() [1/4]
|
inline |
Constructs a DropSchemaRequest object with default parameters.
Definition at line 111 of file DropSchema.cs.
◆ DropSchemaRequest() [2/4]
|
inline |
Constructs a DropSchemaRequest object with the specified parameters.
- Parameters
-
schema_name Name of the schema to be dropped. Must be an existing schema. options Optional parameters. - NO_ERROR_IF_NOT_EXISTS: If TRUE and if the schema specified in schema_name does not exist, no error is returned. If FALSE and if the schema specified in schema_name 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.
Definition at line 162 of file DropSchema.cs.
◆ DropSchemaRequest() [3/4]
|
inline |
Constructs a DropSchemaRequest object with default parameters.
Definition at line 111 of file DropSchema.cs.
◆ DropSchemaRequest() [4/4]
|
inline |
Constructs a DropSchemaRequest object with the specified parameters.
- Parameters
-
schema_name Name of the schema to be dropped. Must be an existing schema. options Optional parameters. - NO_ERROR_IF_NOT_EXISTS: If TRUE and if the schema specified in schema_name does not exist, no error is returned. If FALSE and if the schema specified in schema_name 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.
Definition at line 162 of file DropSchema.cs.
Property Documentation
◆ options
|
getset |
Optional parameters.
- NO_ERROR_IF_NOT_EXISTS: If TRUE and if the schema specified in schema_name does not exist, no error is returned. If FALSE and if the schema specified in schema_name 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 107 of file DropSchema.cs.
◆ schema_name
|
getset |
Name of the schema to be dropped.
Must be an existing schema.
Definition at line 61 of file DropSchema.cs.
The documentation for this class was generated from the following file:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/DropSchema.cs
