/show/schema

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/show/schema

Retrieves information about a schema (or all schemas), as specified in input parameter schema_name.

Input Parameter Description

Name Type Description
schema_name string Name of the schema for which to retrieve the information. If blank, then info for all schemas is returned.
options map of string to strings

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

Supported Parameters (keys) Parameter Description
no_error_if_not_exists

If false will return an error if the provided input parameter schema_name does not exist. If true then it will return an empty result if the provided input parameter schema_name does not exist. The default value is false. The supported values are:

  • true
  • false

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_schema_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/schema endpoint:

Name Type Description
schema_name string Value of input parameter schema_name.
schema_names array of strings A list of all schema names for which information is returned
schema_tables array of arrays of strings An array of arrays containing a list of tables in each of the respective output parameter schema_names.
additional_info array of maps of string to strings Additional information about the respective tables in output parameter schema_names.
info map of string to strings Additional information.

Empty string in case of an error.