/show/tables/bytype

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/show/tables/bytype

Gets names of the tables whose type matches the given criteria. Each table has a particular type. This type comprises the schema and properties of the table and sometimes a type label. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.

Input Parameter Description

NameTypeDescription
type_idstringType id returned by a call to /create/type.
labelstringOptional user supplied label which can be used instead of the type_id to retrieve all tables with the given label.
optionsmap of string to stringsOptional parameters. The default value is an empty map ( {} ).

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_tables_by_type_request' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

This embedded JSON represents the result of the /show/tables/bytype endpoint:

NameTypeDescription
table_namesarray of stringsList of tables matching the input criteria.
infomap of string to stringsAdditional information.

Empty string in case of an error.