A set of parameters for Kinetica.clearTable. More...
Inheritance diagram for kinetica.ClearTableRequest:
Collaboration diagram for kinetica.ClearTableRequest:
Classes | |
| struct | Options |
| A set of string constants for the parameter options. More... | |
Public Member Functions | |
| ClearTableRequest () | |
| Constructs a ClearTableRequest object with default parameters. More... | |
| ClearTableRequest (string table_name=null, string authorization=null, IDictionary< string, string > options=null) | |
| Constructs a ClearTableRequest 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 | table_name = "" [get, set] |
| Name of the table to be cleared, in [schema_name. More... | |
| string | authorization = "" [get, set] |
| No longer used. 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.clearTable.
Clears (drops) one or all tables in the database cluster. The operation is synchronous meaning that the table will be cleared before the function returns. The response payload returns the status of the operation along with the name of the table that was cleared.
Definition at line 19 of file ClearTable.cs.
Constructor & Destructor Documentation
◆ ClearTableRequest() [1/2]
|
inline |
Constructs a ClearTableRequest object with default parameters.
Definition at line 91 of file ClearTable.cs.
◆ ClearTableRequest() [2/2]
|
inline |
Constructs a ClearTableRequest object with the specified parameters.
- Parameters
-
table_name Name of the table to be cleared, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. Empty string clears all available tables, though this behavior is be prevented by default via gpudb.conf parameter 'disable_clear_all'. The default value is ''. authorization No longer used. User can pass an empty string. The default value is ''. options Optional parameters. The default value is an empty Dictionary.
Definition at line 131 of file ClearTable.cs.
Property Documentation
◆ authorization
|
getset |
No longer used.
User can pass an empty string. The default value is ''.
Definition at line 59 of file ClearTable.cs.
◆ options
|
getset |
Optional parameters.
- NO_ERROR_IF_NOT_EXISTS: If TRUE and if the table specified in table_name does not exist no error is returned. If FALSE and if the table specified in table_name does not exist then an error is returned. Supported values: The default value is FALSE.
The default value is an empty Dictionary.
Definition at line 87 of file ClearTable.cs.
◆ table_name
|
getset |
Name of the table to be cleared, in [schema_name.
]table_name format, using standard name resolution rules.
Must be an existing table. Empty string clears all available tables, though this behavior is be prevented by default via gpudb.conf parameter 'disable_clear_all'. The default value is ''.
Definition at line 54 of file ClearTable.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/ClearTable.cs
