/show/types - Kinetica Docs

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

string

Type Id returned in response to a call to /create/type.

string

Option string that was supplied by user in a call to /create/type.

map of string to strings

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

Show options

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 Kinetica 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:

String

‘OK’ or ‘ERROR’

String

Empty if success or an error message

String

‘show_types_response’ or ‘none’ in case of an error

String

Empty string

JSON or String

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

Show data_str

array of strings

The type IDs of the matching types.

array of strings

The Avro schema strings describing each matching type.

array of strings

The user-defined labels of each matching type.

array of maps of string to arrays of strings

The column properties of each matching type.

map of string to strings

Additional information.

Empty string in case of an error.

⌘I

​Input Parameter Description

​Output Parameter Description

Input Parameter Description

Output Parameter Description