Skip to main content

◆ clearTable() [1/2]

ClearTableResponse kinetica.Kinetica.clearTable (ClearTableRequestrequest_)
inline

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.

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

Definition at line 16242 of file KineticaFunctions.cs.

◆ clearTable() [2/2]

ClearTableResponse kinetica.Kinetica.clearTable (stringtable_name = "",
stringauthorization = "",
IDictionary< string, string >options = null )
inline

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.

Parameters
table_nameName 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 ”.
authorizationNo longer used. User can pass an empty string. The default value is ”.
optionsOptional 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.
Returns
Response object containing the result of the operation.

Definition at line 16319 of file KineticaFunctions.cs.

◆ ClearTableAsync() [1/2]

async System.Threading.Tasks.Task< ClearTableResponse > kinetica.Kinetica.ClearTableAsync (ClearTableRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
inline

Clears (drops) one or all tables in the database cluster.

(async)

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.

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 16262 of file KineticaFunctions.cs.

◆ ClearTableAsync() [2/2]

async System.Threading.Tasks.Task< ClearTableResponse > kinetica.Kinetica.ClearTableAsync (stringtable_name = "",
stringauthorization = "",
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
inline

Clears (drops) one or all tables in the database cluster.

(async)

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.

Parameters
table_nameName 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 ”.
authorizationNo longer used. User can pass an empty string. The default value is ”.
optionsOptional 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.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 16377 of file KineticaFunctions.cs.