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

Retrieves detailed information about tables, views, and collections.

If tableName specifies a table or view, information specific to that entity will be returned.

If tableName specifies a collection, the call can return information about either the collection itself (setting the show_children option to false) or the tables and views it contains (setting show_children to true).

If tableName is empty, information about all collections and top-level tables and views can be returned. Note: show_children must be set to true.

If tableName is '*', information about all tables, collections, and views will be returned. Note: show_children must be set to true.

If the option get_sizes is set to true, then the sizes (objects and elements) of each table are returned (in sizes and fullSizes), along with the total number of objects in the requested table (in totalSize and totalFullSize).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShowTableRequest.Options Optional parameters.

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()
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
String	getTableName()
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)
ShowTableRequest	setTableName(String tableName)
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. If blank, then information about all collections and top-level tables and views is returned.

options - Optional parameters.

• 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_SIZES: If true then the table sizes will be returned; blank, otherwise. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SHOW_CHILDREN: If tableName is a collection, then true will return information about the children of the collection, while false will return information about the collection itself. If tableName is empty or '*', then show_children must be true (or not specified); otherwise, no results will be returned. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• 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.
• 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()

Returns:

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.

setTableName

public ShowTableRequest setTableName(String tableName)

Parameters:

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

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters.

• 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_SIZES: If true then the table sizes will be returned; blank, otherwise. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SHOW_CHILDREN: If tableName is a collection, then true will return information about the children of the collection, while false will return information about the collection itself. If tableName is empty or '*', then show_children must be true (or not specified); otherwise, no results will be returned. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• 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.
• 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.

setOptions

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

Parameters:

options - Optional parameters.

• 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_SIZES: If true then the table sizes will be returned; blank, otherwise. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SHOW_CHILDREN: If tableName is a collection, then true will return information about the children of the collection, while false will return information about the collection itself. If tableName is empty or '*', then show_children must be true (or not specified); otherwise, no results will be returned. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• 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.
• 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:

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