A set of parameters for Kinetica.clearTable. More…
Classes | |
| struct | Options |
| A set of string constants for the parameter ClearTableRequest.options. More… | |
Public Member Functions | |
| ClearTableRequest () | |
| Constructs a ClearTableRequest object with default parameters. | |
| ClearTableRequest (string table_name=null, string authorization=null, IDictionary< string, string > options=null) | |
| Constructs a ClearTableRequest object with the specified parameters. | |
| ClearTableRequest () | |
| Constructs a ClearTableRequest object with default parameters. | |
| ClearTableRequest (string table_name=null, string authorization=null, IDictionary< string, string > options=null) | |
| Constructs a ClearTableRequest object with the specified parameters. | |
| Public Member Functions inherited from kinetica.KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
Properties | |
| string | table_name = "" [get, set] |
| Name of the table to be cleared, in [schema_name. | |
| string | authorization = "" [get, set] |
| No longer used. | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Optional parameters. | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class. | |
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. | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. | |
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/4]
| inline |
Constructs a ClearTableRequest object with default parameters.
Definition at line 109 of file ClearTable.cs.
◆ ClearTableRequest() [2/4]
| inline |
Constructs a ClearTableRequest object with the specified 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.
|
Definition at line 154 of file ClearTable.cs.
◆ ClearTableRequest() [3/4]
| inline |
Constructs a ClearTableRequest object with default parameters.
Definition at line 109 of file ClearTable.cs.
◆ ClearTableRequest() [4/4]
| inline |
Constructs a ClearTableRequest object with the specified 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.
|
Definition at line 154 of file ClearTable.cs.
Property Documentation
◆ authorization
| getset |
No longer used.
User can pass an empty string. The default value is ”.
Definition at line 72 of file ClearTable.cs.
◆ options
| getset |
Optional parameters.
- NO_ERROR_IF_NOT_EXISTS: If TRUE and if the table specified in ClearTableRequest.table_name does not exist no error is returned. If FALSE and if the table specified in ClearTableRequest.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 105 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 67 of file ClearTable.cs.
The documentation for this class was generated from the following files:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/ClearTable.cs
- Kinetica/Protocol/ClearTable.cs