/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

Name Type Description
table_names array of strings Names 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.
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_table_metadata_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/table/metadata endpoint:

Name Type Description
table_names array of strings Value of input parameter table_names.
metadata_maps array of maps of string to strings A 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.
info map of string to strings Additional information.

Empty string in case of an error.