/show/table

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/show/table

Retrieves detailed information about a table, view, or collection, specified in input parameter table_name. If the supplied input parameter table_name is a collection, the call can return information about either the collection itself or the tables and views it contains. If input parameter table_name is empty, information about all collections and top-level tables and views can be returned.

If the option get_sizes is set to true, then the sizes (objects and elements) of each table are returned (in output parameter sizes and output parameter full_sizes), along with the total number of objects in the requested table (in output parameter total_size and output parameter total_full_size).

For a collection, setting the show_children option to false returns only information about the collection itself; setting show_children to true returns a list of tables and views contained in the collection, along with their description, type id, schema, type label, type properties, and additional information including TTL.

Input Parameter Description

Name	Type	Description
table_name	string	Name of the table for which to retrieve the information. If blank, then information about all collections and top-level tables and views is returned.
options	map of strings	Optional parameters. Default value is an empty map ( {} ). Supported Parameters (keys) Parameter Description get_sizes If true then the table sizes will be returned; blank, otherwise. Default value is 'false'. The allowed values are: true false show_children If input parameter table_name is a collection, then true will return information about the children of the collection, and false will return information about the collection itself. If input parameter table_name is a table or view, show_children must be false. If input parameter table_name is empty, then show_children must be true. Default value is 'true'. The allowed values are: true false no_error_if_not_exists If false will return an error if the provided input parameter table_name does not exist. If true then it will return an empty result. Default value is 'false'. The allowed values are: true false

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_table_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/table endpoint: Name Type Description table_name string Value of input parameter table_name. table_names array of strings If input parameter table_name is a table or view, then the single element of the array is input parameter table_name. If input parameter table_name is a collection and show_children is set to true, then this array is populated with the names of all tables and views contained by the given collection; if show_children is false then this array will only include the collection name itself. If input parameter table_name is an empty string, then the array contains the names of all collections and top-level tables. table_descriptions array of arrays of strings List of descriptions for the respective tables in output parameter table_names. The allowed values are: COLLECTION VIEW REPLICATED JOIN RESULT_TABLE type_ids array of strings Type ids of the respective tables in output parameter table_names. type_schemas array of strings Type schemas of the respective tables in output parameter table_names. type_labels array of strings Type labels of the respective tables in output parameter table_names. properties array of maps of arrays of strings Property maps of the respective tables in output parameter table_names. additional_info array of maps of strings Additional information about the respective tables in output parameter table_names. Supported List Entries Description map of strings Default value is an empty map ( {} ). Supported Parameters (keys) Parameter Description allow_homogeneous_tables Only present if the respective table is a collection. The value indicates whether the collection is allowed to contain multiple tables or views of the same type or not. The allowed values are: true false protected Indicates whether the respective table is protected or not. The allowed values are: true false table_ttl The value of TTL setting, in minutes, for the respective table (-1 if it will never expire). This is not the remaining amount of time before the table expires. Not present for collections. remaining_table_ttl The remaining amount of minutes before the respective table expires (-1 if it will never expire). This value may be different from the table's TTL setting. Not present for collections. foreign_keys Semicolon-separated list of foreign key constraints, of the format 'source_column references target_table(primary_key_column)'. Not present for collections. Default value is ''. foreign_shard_key Foreign shard key description of the format: <fk_foreign_key> references <pk_column_name> from <pk_table_name>(<pk_primary_key>). Not present for collections. Default value is ''. attribute_indexes Semicolon-separated list of columns that have attribute indexes. Not present for collections. Default value is ''. sizes array of longs Empty array if the get_sizes option is false. Otherwise, sizes of the respective tables represented in output parameter table_names. For all but track data types, this is simply the number of total objects in a table. For track types, since each track semantically contains many individual objects, the output parameter sizes are the counts of conceptual tracks (each of which may be associated with multiple objects). full_sizes array of longs Empty array if the get_sizes option is false. Otherwise, number of total objects in the respective tables represented in output parameter table_names. For all but track data types, this is the same as output parameter sizes. For track types, since each track semantically contains many individual objects, output parameter full_sizes is the count of total objects. join_sizes array of doubles Empty array if the get_sizes option is false. Otherwise, number of unfiltered objects in the cross product of the sub-tables in the joined-tables represented in output parameter table_names. For simple tables, this number will be the same as output parameter sizes. For join-tables this value gives the number of joined-table rows that must be processed by any aggregate functions operating on the table. total_size long -1 if the get_sizes option is false. Otherwise, the sum of the elements of output parameter sizes. total_full_size long -1 if the get_sizes option is false. The sum of the elements of output parameter full_sizes. Empty string in case of an error.