/show/table

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

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

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

For a schema, setting the show_children option to false returns only information about the schema itself; setting show_children to true returns a list of tables and views contained in the schema, along with their corresponding detail.

To retrieve a list of every table, view, and schema in the database, set input parameter table_name to '*' and show_children to true. When doing this, the returned output parameter total_size and output parameter total_full_size will not include the sizes of non-base tables (e.g., filters, views, joins, etc.).

Input Parameter Description

NameTypeDescription
table_namestringName of the table for which to retrieve the information, in [schema_name.]table_name format, using standard name resolution rules. If blank, then returns information about all tables and views.
optionsmap of string to strings

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

Supported Parameters (keys)Parameter Description
force_synchronous

If true then the table sizes will wait for read lock before returning. The default value is true. The supported values are:

  • true
  • false
get_sizes

If true then the number of records in each table, along with a cumulative count, will be returned; blank, otherwise. The default value is false. The supported values are:

  • true
  • false
show_children

If input parameter table_name is a schema, then true will return information about the tables and views in the schema, and false will return information about the schema 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. The default value is true. The supported 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. The default value is false. The supported values are:

  • true
  • false
get_column_info

If true then column info (memory usage, etc) will be returned. The default value is false. The supported 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:

NameTypeDescription
statusString'OK' or 'ERROR'
messageStringEmpty if success or an error message
data_typeString'show_table_request' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

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

NameTypeDescription
table_namestringValue of input parameter table_name.
table_namesarray of stringsIf 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 schema and show_children is set to true, then this array is populated with the names of all tables and views in the given schema; if show_children is false then this array will only include the schema name itself. If input parameter table_name is an empty string, then the array contains the names of all tables in the user's default schema.
table_descriptionsarray of arrays of strings

List of descriptions for the respective tables in output parameter table_names. Possible values are:

  • COLLECTION
  • JOIN
  • LOGICAL_EXTERNAL_TABLE
  • LOGICAL_VIEW
  • MATERIALIZED_EXTERNAL_TABLE
  • MATERIALIZED_VIEW
  • MATERIALIZED_VIEW_MEMBER
  • MATERIALIZED_VIEW_UNDER_CONSTRUCTION
  • REPLICATED
  • RESULT_TABLE
  • SCHEMA
  • VIEW
type_idsarray of stringsType ids of the respective tables in output parameter table_names.
type_schemasarray of stringsType schemas of the respective tables in output parameter table_names.
type_labelsarray of stringsType labels of the respective tables in output parameter table_names.
propertiesarray of maps of string to arrays of stringsProperty maps of the respective tables in output parameter table_names.
additional_infoarray of maps of string to strings

Additional information about the respective tables in output parameter table_names.

Possible List EntriesDescription
map of string to strings

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

Possible Parameters (keys)Parameter Description
request_avro_type

Method by which this table was created. Possible values are:

  • create_table
  • create_projection
  • create_union
request_avro_jsonThe JSON representation of request creating this table. The default value is ''.
protected

No longer used. Indicated whether the respective table was protected or not. Possible values are:

  • true
  • false
record_bytesThe number of in-memory bytes per record which is the sum of the byte sizes of all columns with property 'data'.
collection_names[DEPRECATED--use schema_name instead] This will now contain the name of the schema for the table. There can only be one schema for a table.
schema_nameThe name of the schema for the table. There can only be one schema for a table.
table_ttlThe value of the time-to-live setting. Not present for schemas.
remaining_table_ttlThe remaining time-to-live, in minutes, before the respective table expires (-1 if it will never expire). Not present for schemas.
foreign_keysSemicolon-separated list of foreign keys, of the format 'source_column references target_table(primary_key_column)'. Not present for schemas. The default value is ''.
foreign_shard_keyForeign shard key description of the format: <fk_foreign_key> references <pk_column_name> from <pk_table_name>(<pk_primary_key>). Not present for schemas. The default value is ''.
partition_type

Partitioning scheme used for this table The default value is NONE.

Possible ValuesDescription
RANGEUsing range partitioning
INTERVALUsing interval partitioning
LISTUsing manual list partitioning
NONEUsing no partitioning
partition_keysComma-separated list of partition keys. The default value is ''.
partition_definitionsComma-separated list of partition definitions, whose format depends on the partition_type. See partitioning documentation for details. The default value is ''.
is_automatic_partitionTrue if partitions will be created for LIST VALUES which don't fall into existing partitions. The default value is ''.
attribute_indexesSemicolon-separated list of columns that have indexes. Not present for schemas. The default value is ''.
compressed_columnsSemicolon-separated list of compressed columns with the corresponding compression type for each; e.g.: {first_name,snappy};{last_name,lz4hc}. Not present for schemas. The default value is ''.
column_infoJSON-encoded string representing a map of column name to information including memory usage if if the get_column_info option is true. The default value is ''.
global_access_mode

Returns the global access mode (i.e. lock status) for the table.

Possible ValuesDescription
no_accessNo read/write operations are allowed on this table.
read_onlyOnly read operations are allowed on this table.
write_onlyOnly write operations are allowed on this table.
read_writeAll read/write operations are allowed on this table.
view_table_nameFor materialized view the name of the view this member table is part of - if same as the table_name then this is the root of the view. The default value is ''.
is_view_persistedTrue if the view named view_table_name is persisted - reported for each view member. Means method of recreating this member is saved - not the members data. The default value is ''.
is_dirtyTrue if some input table of the materialized view that affects this member table has been modified since the last refresh. The default value is ''.
refresh_methodFor materialized view current refresh_method - one of manual, periodic, on_change. The default value is ''.
refresh_start_timeFor materialized view with periodic refresh_method the current intial datetime string that periodic refreshes began. The default value is ''.
refresh_periodFor materialized view with periodic refresh_method the current refresh period in seconds. The default value is ''.
last_refresh_timeFor materialized view the a datatime string indicating the last time the view was refreshed. The default value is ''.
next_refresh_timeFor materialized view with periodic refresh_method a datetime string indicating the next time the view is to be refreshed. The default value is ''.
user_chunk_sizeUser-specified number of records per chunk, if provided at table creation time. The default value is ''.
alternate_shard_keysSemicolon-separated list of shard keys that were equated in joins (applicable for join tables). The default value is ''.
sizesarray of longsIf get_sizes is true, an array containing the number of records of each corresponding table in output parameter table_names. Otherwise, an empty array.
full_sizesarray of longsIf get_sizes is true, an array containing the number of records of each corresponding table in output parameter table_names (same values as output parameter sizes). Otherwise, an empty array.
join_sizesarray of doublesIf get_sizes is true, an array containing the number of unfiltered records in the cross product of the sub-tables of each corresponding join-table 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. Otherwise, (if get_sizes is false), an empty array.
total_sizelongIf get_sizes is true, the sum of the elements of output parameter sizes. Otherwise, -1.
total_full_sizelongIf get_sizes is true, the sum of the elements of output parameter full_sizes (same value as output parameter total_size). Otherwise, -1.
infomap of string to stringsAdditional information.

Empty string in case of an error.