/show/types

URL: http://<db.host>:<db.port>/show/types

Retrieves information for the specified data type ID or type label. For all data types that match the input criteria, the database returns the type ID, the type schema, the label (if available), and the type's column properties.

Input Parameter Description

NameTypeDescription
type_idstringType Id returned in response to a call to /create/type.
labelstringOption string that was supplied by user in a call to /create/type.
optionsmap of string to strings

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

Supported Parameters (keys)Parameter Description
no_join_types

When set to 'true', no join types will be included. 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:

NameTypeDescription
statusString'OK' or 'ERROR'
messageStringEmpty if success or an error message
data_typeString'show_types_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

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

NameTypeDescription
type_idsarray of strings 
type_schemasarray of strings 
labelsarray of strings 
propertiesarray of maps of string to arrays of strings 
infomap of string to stringsAdditional information.

Empty string in case of an error.