/show/datasink

URL: http://<db.host>:<db.port>/show/datasink

Shows information about a specified data sink or all data sinks.

Input Parameter Description

NameTypeDescription
namestringName of the data sink for which to retrieve information. The name must refer to a currently existing data sink. If '*' is specified, information about all data sinks will be returned.
optionsmap of string to stringsOptional parameters. The default value is an empty map ( {} ).

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:

NameTypeDescription
statusString'OK' or 'ERROR'
messageStringEmpty if success or an error message
data_typeString'show_datasink_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

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

NameTypeDescription
datasink_namesarray of stringsThe data sink names.
destination_typesarray of stringsThe destination type of the data sinks named in output parameter datasink_names.
additional_infoarray of maps of string to strings

Additional information about the respective data sinks in output parameter datasink_names.

Possible List EntriesDescription
map of string to strings

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

Possible Parameters (keys)Parameter Description
destinationDestination for the output data in 'destination_type://path[:port]' format
kafka_topic_nameKafka topic if the data sink type is a Kafka broker
user_nameName of the remote system user
infomap of string to stringsAdditional information.

Empty string in case of an error.