Skip to main content
show_datasink(name=None, options=)[source]

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

Parameters

name (str) –

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 (dict of str to str) –

Optional parameters. The default value is an empty dict ( ).

Returns

A dict with the following entries–

datasink_names (list of str) –

The data sink names.

destination_types (list of str) –

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

additional_info (list of dicts of str to str) –

Additional information about the respective data sinks in output parameter datasink_names. Allowed keys are:

  • 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 (dict of str to str) –

Additional information.