/show/datasource

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/show/datasource

Shows information about a specified data source or all data sources.

Input Parameter Description

NameTypeDescription
namestringName of the data source for which to retrieve information. The name must refer to a currently existing data source. If '*' is specified, information about all data sources 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_datasource_request' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

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

NameTypeDescription
datasource_namesarray of stringsThe data source names.
storage_provider_typesarray of strings

The storage provider type of the data sources named in output parameter datasource_names.

Possible List EntriesDescription
hdfsApache Hadoop Distributed File System
s3Amazon S3 bucket
additional_infoarray of maps of string to strings

Additional information about the respective data sources in output parameter datasource_names.

Possible List EntriesDescription
map of string to strings

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

Possible Parameters (keys)Parameter Description
locationLocation of the remote storage in 'storage_provider_type://[storage_path[:storage_port]]' format
s3_bucket_nameName of the Amazon S3 bucket used as the data source
s3_regionName of the Amazon S3 region where the bucket is located
hdfs_kerberos_keytabKerberos key for the given HDFS user
user_nameName of the remote system user
infomap of string to stringsAdditional information.

Empty string in case of an error.