A set of parameters for Kinetica.clearTables. More...
Inheritance diagram for kinetica.ClearTablesRequest:
Collaboration diagram for kinetica.ClearTablesRequest:
Classes | |
| struct | Options |
| A set of string constants for the parameter options. More... | |
Public Member Functions | |
| ClearTablesRequest () | |
| Constructs a ClearTablesRequest object with default parameters. More... | |
| ClearTablesRequest (IList< string > table_names=null, IDictionary< string, string > options=null) | |
| Constructs a ClearTablesRequest object with the specified parameters. More... | |
| ClearTablesRequest () | |
| Constructs a ClearTablesRequest object with default parameters. More... | |
| ClearTablesRequest (IList< string > table_names=null, IDictionary< string, string > options=null) | |
| Constructs a ClearTablesRequest 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 | |
| IList< string > | table_names = new List<string>() [get, set] |
| Names of the tables to be cleared, in [schema_name. 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.clearTables.
Clears (drops) tables in the database cluster. The operation is synchronous meaning that the tables will be cleared before the function returns. The response payload returns the status of the operation for each table requested.
Definition at line 18 of file ClearTables.cs.
Constructor & Destructor Documentation
◆ ClearTablesRequest() [1/4]
|
inline |
Constructs a ClearTablesRequest object with default parameters.
Definition at line 85 of file ClearTables.cs.
◆ ClearTablesRequest() [2/4]
|
inline |
Constructs a ClearTablesRequest object with the specified parameters.
- Parameters
-
table_names Names of the tables to be cleared, in [schema_name.]table_name format, using standard name resolution rules. Must be existing tables. Empty list clears all available tables, though this behavior is be prevented by default via gpudb.conf parameter 'disable_clear_all'. The default value is an empty List. options Optional parameters. The default value is an empty Dictionary.
Definition at line 123 of file ClearTables.cs.
◆ ClearTablesRequest() [3/4]
|
inline |
Constructs a ClearTablesRequest object with default parameters.
Definition at line 85 of file ClearTables.cs.
◆ ClearTablesRequest() [4/4]
|
inline |
Constructs a ClearTablesRequest object with the specified parameters.
- Parameters
-
table_names Names of the tables to be cleared, in [schema_name.]table_name format, using standard name resolution rules. Must be existing tables. Empty list clears all available tables, though this behavior is be prevented by default via gpudb.conf parameter 'disable_clear_all'. The default value is an empty List. options Optional parameters. The default value is an empty Dictionary.
Definition at line 123 of file ClearTables.cs.
Property Documentation
◆ options
|
getset |
Optional parameters.
- NO_ERROR_IF_NOT_EXISTS: If TRUE and if a table specified in table_names does not exist no error is returned. If FALSE and if a table specified in table_names 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 81 of file ClearTables.cs.
◆ table_names
|
getset |
Names of the tables to be cleared, in [schema_name.
]table_name format, using standard name resolution rules.
Must be existing tables. Empty list clears all available tables, though this behavior is be prevented by default via gpudb.conf parameter 'disable_clear_all'. The default value is an empty List.
Definition at line 53 of file ClearTables.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/ClearTables.cs
