Skip to main content

◆ showTable() [1/4]

ShowTableResponse gpudb::GPUdb::showTable (const ShowTableRequest &request_) const

Retrieves detailed information about a table, view, or schema, specified in tableName.

If the supplied tableName is a schema the call can return information about either the schema itself or the tables and views it contains. If tableName 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 sizes and fullSizes), along with the total number of objects across all requested tables (in totalSize and totalFullSize).

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 tableName to ’*’ and show_children to true. When doing this, the returned totalSize and totalFullSize will not include the sizes of non-base tables (e.g., filters, views, joins, etc.).

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ showTable() [2/4]

ShowTableResponse & gpudb::GPUdb::showTable (const ShowTableRequest &request_,
ShowTableResponse &response_ ) const

Retrieves detailed information about a table, view, or schema, specified in tableName.

If the supplied tableName is a schema the call can return information about either the schema itself or the tables and views it contains. If tableName 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 sizes and fullSizes), along with the total number of objects across all requested tables (in totalSize and totalFullSize).

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 tableName to ’*’ and show_children to true. When doing this, the returned totalSize and totalFullSize will not include the sizes of non-base tables (e.g., filters, views, joins, etc.).

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ showTable() [3/4]

ShowTableResponse gpudb::GPUdb::showTable (const std::string &tableName,
const std::map< std::string, std::string > &options ) const

Retrieves detailed information about a table, view, or schema, specified in tableName.

If the supplied tableName is a schema the call can return information about either the schema itself or the tables and views it contains. If tableName 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 sizes and fullSizes), along with the total number of objects across all requested tables (in totalSize and totalFullSize).

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 tableName to ’*’ and show_children to true. When doing this, the returned totalSize and totalFullSize will not include the sizes of non-base tables (e.g., filters, views, joins, etc.).

Parameters
[in]tableNameName 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.
[in]optionsOptional parameters.The default value is an empty map.
Returns
Response object containing the result of the operation.

◆ showTable() [4/4]

ShowTableResponse & gpudb::GPUdb::showTable (const std::string &tableName,
const std::map< std::string, std::string > &options,
ShowTableResponse &response_ ) const

Retrieves detailed information about a table, view, or schema, specified in tableName.

If the supplied tableName is a schema the call can return information about either the schema itself or the tables and views it contains. If tableName 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 sizes and fullSizes), along with the total number of objects across all requested tables (in totalSize and totalFullSize).

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 tableName to ’*’ and show_children to true. When doing this, the returned totalSize and totalFullSize will not include the sizes of non-base tables (e.g., filters, views, joins, etc.).

Parameters
[in]tableNameName 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.
[in]optionsOptional parameters.The default value is an empty map.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).