Note
This documentation is for a prior release of Kinetica. For the latest documentation, click here.
URL: https://<aws.fqdn>/<aws.cluster.name>/gpudb-0/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
| Name | Type | Description |
|---|---|---|
| type_id | string | Type id returned by a call to /create/type. |
| label | string | Optional user supplied label which can be used instead of the type_id to retrieve all tables with the given label. |
| options | map of string to strings | Optional 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:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| status | String | 'OK' or 'ERROR' | |||||||||
| message | String | Empty if success or an error message | |||||||||
| data_type | String | 'show_tables_by_type_response' 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/tables/bytype endpoint:
Empty string in case of an error. |
