/drop/datasink

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/drop/datasink

Drops an existing data sink.

By default, if any table monitors use this sink as a destination, the request will be blocked unless option clear_table_monitors is true.

Input Parameter Description

Name Type Description
name string Name of the data sink to be dropped. Must be an existing data sink.
options map of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys) Parameter Description
clear_table_monitors

If true, any table monitors that use this data sink will be cleared. The default value is false. The supported values are:

  • true
  • false

Output Parameter Description

The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

Name Type Description
status String 'OK' or 'ERROR'
message String Empty if success or an error message
data_type String 'drop_datasink_response' or 'none' in case of an error
data String Empty string
data_str JSON or String

This embedded JSON represents the result of the /drop/datasink endpoint:

Name Type Description
name string Value of input parameter name.
info map of string to strings Additional information.

Empty string in case of an error.