gpudb::ShowTableResponse Struct Reference

A set of results returned by GPUdb::showTable. More...

#include <gpudb/protocol/show_table.h>

Public Member Functions
	ShowTableResponse ()
	Constructs a ShowTableResponse object with default parameters. More...

Public Attributes
std::string	tableName
	Value of tableName. More...
std::vector< std::string >	tableNames
	If tableName is a table or view, then the single element of the array is tableName. More...
std::vector< std::vector< std::string > >	tableDescriptions
	List of descriptions for the respective tables in tableNames. More...
std::vector< std::string >	typeIds
	Type IDs of the respective tables in tableNames. More...
std::vector< std::string >	typeSchemas
	Type schemas of the respective tables in tableNames. More...
std::vector< std::string >	typeLabels
	Type labels of the respective tables in tableNames. More...
std::vector< std::map< std::string, std::vector< std::string > > >	properties
	Property maps of the respective tables in tableNames. More...
std::vector< std::map< std::string, std::string > >	additionalInfo
	Additional information about the respective tables in tableNames. More...
std::vector< int64_t >	sizes
	If get_sizes is true, an array containing the number of records of each corresponding table in tableNames. More...
std::vector< int64_t >	fullSizes
	If get_sizes is true, an array containing the number of records of each corresponding table in tableNames (same values as sizes). More...
std::vector< double >	joinSizes
	If 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 tableNames. More...
int64_t	totalSize
	If get_sizes is true, the sum of the elements of sizes. More...
int64_t	totalFullSize
	If get_sizes is true, the sum of the elements of fullSizes (same value as totalSize). More...
std::map< std::string, std::string >	info
	Additional information. More...

Detailed Description

A set of results returned by GPUdb::showTable.

Definition at line 438 of file show_table.h.

Constructor & Destructor Documentation

ShowTableResponse()

gpudb::ShowTableResponse::ShowTableResponse ( )

inline

Constructs a ShowTableResponse object with default parameters.

Definition at line 443 of file show_table.h.

Member Data Documentation

additionalInfo

std::vector<std::map<std::string, std::string> > gpudb::ShowTableResponse::additionalInfo

Additional information about the respective tables in tableNames.

• show_table_request_avro_type: Method by which this table was created. Supported values:
  • show_table_create_table
  • show_table_create_projection
  • show_table_create_union
• show_table_request_avro_json: The JSON representation of request creating this table. The default value is ''.
• show_table_protected: No longer used. Indicated whether the respective table was protected or not. Supported values:
  • show_table_true
  • show_table_false
• show_table_record_bytes: The number of in-memory bytes per record which is the sum of the byte sizes of all columns with property 'data'.
• show_table_total_bytes: The total size in bytes of all data stored in the table.
• show_table_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.
• show_table_schema_name: The name of the schema for the table. There can only be one schema for a table.
• show_table_table_ttl: The value of the time-to-live setting. Not present for schemas.
• show_table_remaining_table_ttl: The remaining time-to-live, in minutes, before the respective table expires (-1 if it will never expire). Not present for schemas.
• show_table_primary_key_type: The primary key type of the table (if it has a primary key). Supported values:
  • show_table_memory: In-memory primary key
  • show_table_disk: On-disk primary key
• show_table_foreign_keys: Semicolon-separated list of foreign keys, of the format 'source_column references target_table(primary_key_column)'. Not present for schemas. The default value is ''.
• show_table_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 schemas. The default value is ''.
• show_table_partition_type: Partitioning scheme used for this table. Supported values:
  • show_table_RANGE: Using range partitioning
  • show_table_INTERVAL: Using interval partitioning
  • show_table_LIST: Using manual list partitioning
  • show_table_HASH: Using hash partitioning.
  • show_table_SERIES: Using series partitioning.
  • show_table_NONE: Using no partitioning
  The default value is show_table_NONE.
• show_table_partition_keys: Comma-separated list of partition keys. The default value is ''.
• show_table_partition_definitions: Comma-separated list of partition definitions, whose format depends on the partition_type. See partitioning documentation for details. The default value is ''.
• show_table_is_automatic_partition: True if partitions will be created for LIST VALUES which don't fall into existing partitions. The default value is ''.
• show_table_attribute_indexes: Semicolon-separated list of indexes. For column (attribute) indexes, only the indexed column name will be listed. For other index types, the index type will be listed with the colon-delimited indexed column(s) and the comma-delimited index option(s) using the form: <index_type>&lt;column_list>&lt;column_options>. Not present for schemas. The default value is ''.
• show_table_column_info: JSON-encoded string representing a map of column name to information including memory usage if the get_column_info option is true. The default value is ''.
• show_table_global_access_mode: Returns the global access mode (i.e. lock status) for the table. Supported values:
  • show_table_no_access: No read/write operations are allowed on this table.
  • show_table_read_only: Only read operations are allowed on this table.
  • show_table_write_only: Only write operations are allowed on this table.
  • show_table_read_write: All read/write operations are allowed on this table.
• show_table_view_table_name: For 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 ''.
• show_table_is_view_persisted: True 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 ''.
• show_table_is_dirty: True if some input table of the materialized view that affects this member table has been modified since the last refresh. The default value is ''.
• show_table_refresh_method: For materialized view current refresh_method - one of manual, periodic, on_change. The default value is ''.
• show_table_refresh_start_time: For materialized view with periodic refresh_method the initial datetime string that periodic refreshes began. The default value is ''.
• show_table_refresh_stop_time: Time at which the periodic view refresh stops. The default value is ''.
• show_table_refresh_period: For materialized view with periodic refresh_method the current refresh period in seconds. The default value is ''.
• show_table_last_refresh_time: For materialized view the datetime string indicating the last time the view was refreshed. The default value is ''.
• show_table_next_refresh_time: For materialized view with periodic refresh_method a datetime string indicating the next time the view is to be refreshed. The default value is ''.
• show_table_user_chunk_size: User-specified number of records per chunk, if provided at table creation time. The default value is ''.
• show_table_user_chunk_column_max_memory: User-specified target max bytes per column in a chunk, if provided at table creation time. The default value is ''.
• show_table_user_chunk_max_memory: User-specified target max bytes for all columns in a chunk, if provided at table creation time. The default value is ''.
• show_table_owner_resource_group: Name of the owner resource group. The default value is ''.
• show_table_alternate_shard_keys: Semicolon-separated list of shard keys that were equated in joins (applicable for join tables). The default value is ''.
• show_table_datasource_subscriptions: Semicolon-separated list of datasource names the table has subscribed to. The default value is ''.
• show_table_null_modifying_columns: Comma-separated list of null modifying column names. The default value is ''.
• show_table_compression_codec: Default compression codec for the table. The default value is ''.
• show_table_created_by: User that created this table or view. The default value is ''.
• show_table_created_time: Time (UTC) when this table or view was created. The default value is ''.
• show_table_last_read_by: User that last read this table or view. The default value is ''.
• show_table_last_read_time: Time (UTC) when this table or view was last read. The default value is ''.
• show_table_read_count: Count of times this table or view was read. The default value is ''.
• show_table_last_write_by: User that last wrote to this table. The default value is ''.
• show_table_last_write_time: Time (UTC) when this table was last written. The default value is ''.
• show_table_write_count: Count of times this table was written. The default value is ''.
• show_table_last_alter_by: User that last altered this table or view. The default value is ''.
• show_table_last_alter_time: Time (UTC) when this table or view was last altered. The default value is ''.
• show_table_alter_count: Count of times this table or view was altered. The default value is ''.

Definition at line 785 of file show_table.h.

fullSizes

std::vector<int64_t> gpudb::ShowTableResponse::fullSizes

If get_sizes is true, an array containing the number of records of each corresponding table in tableNames (same values as sizes).

Otherwise, an empty array.

Definition at line 801 of file show_table.h.

info

std::map<std::string, std::string> gpudb::ShowTableResponse::info

Additional information.

Definition at line 833 of file show_table.h.

joinSizes

std::vector<double> gpudb::ShowTableResponse::joinSizes

If 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 tableNames.

For simple tables, this number will be the same as 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.

Definition at line 814 of file show_table.h.

properties

std::vector<std::map<std::string, std::vector<std::string> > > gpudb::ShowTableResponse::properties

Property maps of the respective tables in tableNames.

Definition at line 527 of file show_table.h.

sizes

std::vector<int64_t> gpudb::ShowTableResponse::sizes

If get_sizes is true, an array containing the number of records of each corresponding table in tableNames.

Otherwise, an empty array.

Definition at line 793 of file show_table.h.

tableDescriptions

std::vector<std::vector<std::string> > gpudb::ShowTableResponse::tableDescriptions

List of descriptions for the respective tables in tableNames.

Supported values:

• show_table_COLLECTION
• show_table_JOIN
• show_table_LOGICAL_EXTERNAL_TABLE
• show_table_LOGICAL_VIEW
• show_table_MATERIALIZED_EXTERNAL_TABLE
• show_table_MATERIALIZED_VIEW
• show_table_MATERIALIZED_VIEW_MEMBER
• show_table_MATERIALIZED_VIEW_UNDER_CONSTRUCTION
• show_table_REPLICATED
• show_table_RESULT_TABLE
• show_table_SCHEMA
• show_table_VIEW

Definition at line 507 of file show_table.h.

tableName

std::string gpudb::ShowTableResponse::tableName

Value of tableName.

Definition at line 464 of file show_table.h.

tableNames

std::vector<std::string> gpudb::ShowTableResponse::tableNames

If tableName is a table or view, then the single element of the array is tableName.

If tableName 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 tableName is an empty string, then the array contains the names of all tables in the user's default schema.

Definition at line 480 of file show_table.h.

totalFullSize

int64_t gpudb::ShowTableResponse::totalFullSize

If get_sizes is true, the sum of the elements of fullSizes (same value as totalSize).

Otherwise, -1.

Definition at line 828 of file show_table.h.

totalSize

int64_t gpudb::ShowTableResponse::totalSize

If get_sizes is true, the sum of the elements of sizes.

Otherwise, -1.

Definition at line 821 of file show_table.h.

typeIds

std::vector<std::string> gpudb::ShowTableResponse::typeIds

Type IDs of the respective tables in tableNames.

Definition at line 512 of file show_table.h.

typeLabels

std::vector<std::string> gpudb::ShowTableResponse::typeLabels

Type labels of the respective tables in tableNames.

Definition at line 522 of file show_table.h.

typeSchemas

std::vector<std::string> gpudb::ShowTableResponse::typeSchemas

Type schemas of the respective tables in tableNames.

Definition at line 517 of file show_table.h.

---

The documentation for this struct was generated from the following file:

• gpudb/protocol/show_table.h