Skip to main content

​
◆ clearTables() [1/2]

ClearTablesResponse kinetica.Kinetica.clearTables (ClearTablesRequestrequest_)
 inline

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.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 16763 of file KineticaFunctions.cs.

​
◆ clearTables() [2/2]

ClearTablesResponse kinetica.Kinetica.clearTables (IList< string >table_names = null,
IDictionary< string, string >options = null )
 inline

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.

Parameters
table_namesNames 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 prevented by default via system configuration parameter disable_clear_all. The default value is an empty List.
optionsOptional 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.
Returns
Response object containing the result of the operation.

Definition at line 16840 of file KineticaFunctions.cs.

​
◆ ClearTablesAsync() [1/2]

async System.Threading.Tasks.Task< ClearTablesResponse > kinetica.Kinetica.ClearTablesAsync (ClearTablesRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
 inline

Clears (drops) tables in the database cluster.

(async)

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.

Parameters
request_Request object containing the parameters for the operation.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 16783 of file KineticaFunctions.cs.

​
◆ ClearTablesAsync() [2/2]

async System.Threading.Tasks.Task< ClearTablesResponse > kinetica.Kinetica.ClearTablesAsync (IList< string >table_names = null,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
 inline

Clears (drops) tables in the database cluster.

(async)

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.

Parameters
table_namesNames 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 prevented by default via system configuration parameter disable_clear_all. The default value is an empty List.
optionsOptional 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.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 16898 of file KineticaFunctions.cs.