Retrieves information about a schema (or all
schemas), as specified in input parameter schema_name.
Input Parameter Description
string
Name of the schema for which to retrieve the information. If blank, then info for all schemas is returned.
map of string to strings
Optional parameters.The default value is an empty map ( {} ).
Show options
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 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_schema_response’ or ‘none’ in case of an error
String
Empty string
JSON or String
This embedded JSON represents the result of the /show/schema endpoint:
Show data_str
string
Value of input parameter schema_name.
array of strings
A list of all schema names for which information is returned.
array of arrays of strings
An array of arrays containing a list of tables in each of the respective output parameter schema_names.
array of maps of string to strings
Additional information about the respective tables in output parameter schema_names.
map of string to strings
Additional information.
Empty string in case of an error.
Assistant
Responses are generated using AI and may contain mistakes.