/show/datasink

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

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

Input Parameter Description

Name	Type	Description
name	string	Name 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.
options	map of string to strings	Optional 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:

Name

Type

Description

status

String

'OK' or 'ERROR'

message

String

Empty if success or an error message

data_type

String

'show_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 /show/datasink endpoint:

Name

Type

Description

datasink_names

array of strings

The data sink names.

destination_types

array of strings

The destination type of the data sinks named in output parameter datasink_names.

additional_info

array of maps of string to strings

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

Possible List Entries

Description

map of string to strings

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

Possible Parameters (keys)	Parameter Description
destination	Destination for the output data in 'destination_type://path[:port]' format
kafka_topic_name	Kafka topic if the data sink type is a Kafka broker
user_name	Name of the remote system user

info

map of string to strings

Additional information.

Empty string in case of an error.