com.gpudb.protocol

Class ShowTableRequest

java.lang.Object

com.gpudb.protocol.ShowTableRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class ShowTableRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.showTable.

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.).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShowTableRequest.Options A set of string constants for the ShowTableRequest parameter options.

Constructor Summary

Constructors

Constructor and Description
ShowTableRequest() Constructs a ShowTableRequest object with default parameters.
ShowTableRequest(String tableName, Map<String,String> options) Constructs a ShowTableRequest object with the specified parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object	get(int index) This method supports the Avro framework and is not intended to be called directly by the user.
static org.apache.avro.Schema	getClassSchema() This method supports the Avro framework and is not intended to be called directly by the user.
Map<String,String>	getOptions() Optional parameters.
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
String	getTableName() Name of the table for which to retrieve the information, in [schema_name.]table_name format, using standard	int	hashCode()
void	put(int index, Object value) This method supports the Avro framework and is not intended to be called directly by the user.
ShowTableRequest	setOptions(Map<String,String> options) Optional parameters.
ShowTableRequest	setTableName(String tableName) Name of the table for which to retrieve the information, in [schema_name.]table_name format, using standard	String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ShowTableRequest

public ShowTableRequest()

Constructs a ShowTableRequest object with default parameters.

ShowTableRequest

public ShowTableRequest(String tableName,
                        Map<String,String> options)

Constructs a ShowTableRequest object with the specified parameters.

Parameters:

tableName - Name 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.

options - Optional parameters.

• DEPENDENCIES: Include view dependencies in the output. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• FORCE_SYNCHRONOUS: If TRUE then the table sizes will wait for read lock before returning. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• GET_ACCESS_DATA: If TRUE then data about the last read, write, alter and create will be returned. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• GET_CACHED_SIZES: If TRUE then the number of records in each table, along with a cumulative count, will be returned; blank, otherwise. This version will return the sizes cached at rank 0, which may be stale if there is a multihead insert occurring. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• GET_SIZES: If TRUE then the number of records in each table, along with a cumulative count, will be returned; blank, otherwise. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SKIP_ADDITIONAL_INFO: If TRUE then the response will not populate the additional_info field. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• NO_ERROR_IF_NOT_EXISTS: If FALSE will return an error if the provided tableName does not exist. If TRUE then it will return an empty result. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SKIP_TEMP_SCHEMAS: If TRUE then the table list will not include tables from SYS_TEMP and other system temporary schemas. This is the default behavior for non-admin users. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SHOW_CHILDREN: If tableName 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 tableName is a table or view, SHOW_CHILDREN must be FALSE. If tableName is empty, then SHOW_CHILDREN must be TRUE. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• GET_COLUMN_INFO: If TRUE then column info (memory usage, etc) will be returned. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

Method Detail

getClassSchema

public static org.apache.avro.Schema getClassSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Returns:

The schema for the class.

getTableName

public String getTableName()

Name 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.

Returns:

The current value of tableName.

setTableName

public ShowTableRequest setTableName(String tableName)

Name 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.

Parameters:

tableName - The new value for tableName.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Optional parameters.

• DEPENDENCIES: Include view dependencies in the output. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• FORCE_SYNCHRONOUS: If TRUE then the table sizes will wait for read lock before returning. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• GET_ACCESS_DATA: If TRUE then data about the last read, write, alter and create will be returned. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• GET_CACHED_SIZES: If TRUE then the number of records in each table, along with a cumulative count, will be returned; blank, otherwise. This version will return the sizes cached at rank 0, which may be stale if there is a multihead insert occurring. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• GET_SIZES: If TRUE then the number of records in each table, along with a cumulative count, will be returned; blank, otherwise. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SKIP_ADDITIONAL_INFO: If TRUE then the response will not populate the additional_info field. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• NO_ERROR_IF_NOT_EXISTS: If FALSE will return an error if the provided tableName does not exist. If TRUE then it will return an empty result. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SKIP_TEMP_SCHEMAS: If TRUE then the table list will not include tables from SYS_TEMP and other system temporary schemas. This is the default behavior for non-admin users. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SHOW_CHILDREN: If tableName 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 tableName is a table or view, SHOW_CHILDREN must be FALSE. If tableName is empty, then SHOW_CHILDREN must be TRUE. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• GET_COLUMN_INFO: If TRUE then column info (memory usage, etc) will be returned. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

Returns:

The current value of options.

setOptions

public ShowTableRequest setOptions(Map<String,String> options)

Optional parameters.

• DEPENDENCIES: Include view dependencies in the output. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• FORCE_SYNCHRONOUS: If TRUE then the table sizes will wait for read lock before returning. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• GET_ACCESS_DATA: If TRUE then data about the last read, write, alter and create will be returned. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• GET_CACHED_SIZES: If TRUE then the number of records in each table, along with a cumulative count, will be returned; blank, otherwise. This version will return the sizes cached at rank 0, which may be stale if there is a multihead insert occurring. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• GET_SIZES: If TRUE then the number of records in each table, along with a cumulative count, will be returned; blank, otherwise. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SKIP_ADDITIONAL_INFO: If TRUE then the response will not populate the additional_info field. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• NO_ERROR_IF_NOT_EXISTS: If FALSE will return an error if the provided tableName does not exist. If TRUE then it will return an empty result. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SKIP_TEMP_SCHEMAS: If TRUE then the table list will not include tables from SYS_TEMP and other system temporary schemas. This is the default behavior for non-admin users. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SHOW_CHILDREN: If tableName 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 tableName is a table or view, SHOW_CHILDREN must be FALSE. If tableName is empty, then SHOW_CHILDREN must be TRUE. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• GET_COLUMN_INFO: If TRUE then column info (memory usage, etc) will be returned. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

Parameters:

options - The new value for options.

Returns:

this to mimic the builder pattern.

getSchema

public org.apache.avro.Schema getSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

getSchema in interface org.apache.avro.generic.GenericContainer

Returns:

The schema object describing this class.

get

public Object get(int index)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

get in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to get

Returns:

value of the field with the given index.

Throws:

IndexOutOfBoundsException

put

public void put(int index,
                Object value)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

put in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to set

value - the value to set

Throws:

IndexOutOfBoundsException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object