URL: http://GPUDB_IP_ADDRESS:GPUDB_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.
Name | Type | Description | ||||
---|---|---|---|---|---|---|
type_id | string | Type Id returned in response to a call to /create/type. | ||||
label | string | Option string that was supplied by user in a call to /create/type. | ||||
options | map of string to strings | Optional parameters. The default value is an empty map ( {} ).
|
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_types_request' 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/types endpoint:
Empty string in case of an error. |