/show/table/metadata

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/show/table/metadata

Retrieves the user provided metadata for the specified tables.

Input Parameter Description

NameTypeDescription
table_namesarray of stringsNames of tables whose metadata will be fetched, in [schema_name.]table_name format, using standard name resolution rules. All provided tables must exist, or an error is 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_table_metadata_request' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

This embedded JSON represents the result of the /show/table/metadata endpoint:

NameTypeDescription
table_namesarray of stringsValue of input parameter table_names.
metadata_mapsarray of maps of string to stringsA list of maps which contain the metadata of the tables in the order the tables are listed in input parameter table_names. Each map has (metadata attribute name, metadata attribute value) pairs.
infomap of string to stringsAdditional information.

Empty string in case of an error.