Skip to main content
  • 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

    • Optionaltable_name: string

      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 prevented by default via system configuration parameter disable_clear_all.

    • Optionalauthorization: string

      No longer used. User can pass an empty string.

    • Optionaloptions: Record<string, string>

      Optional parameters.

    • Optionalcallback: GPUdbCallback

      Optional callback function

    Returns Promise<ClearTableResponse>

    Promise<Types.ClearTableResponse> - Promise resolving to the response

  • 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

    Returns Promise<ClearTableResponse>

    Promise<Types.ClearTableResponse> - Promise resolving to the response