Package com.gpudb.protocol

Class ShowStatisticsRequest

java.lang.Object

com.gpudb.protocol.ShowStatisticsRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.showStatistics.

Retrieves the collected column statistics for the specified table(s).

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ShowStatisticsRequest()	Constructs a ShowStatisticsRequest object with default parameters.
ShowStatisticsRequest(List<String> tableNames, Map<String,String> options)	Constructs a ShowStatisticsRequest object with the specified parameters.

Method Summary

Modifier and Type	Method	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.
List<String>	getTableNames()	Names of tables whose metadata will be fetched, each in [schema_name.]table_name format, using standard name resolution rules.
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.
ShowStatisticsRequest	setOptions(Map<String,String> options)	Optional parameters.
ShowStatisticsRequest	setTableNames(List<String> tableNames)	Names of tables whose metadata will be fetched, each in [schema_name.]table_name format, using standard name resolution rules.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ShowStatisticsRequest

public ShowStatisticsRequest()

Constructs a ShowStatisticsRequest object with default parameters.

ShowStatisticsRequest

public ShowStatisticsRequest(List<String> tableNames,
                             Map<String,String> options)

Constructs a ShowStatisticsRequest object with the specified parameters.

Parameters:

tableNames - Names of tables whose metadata will be fetched, each in [schema_name.]table_name format, using standard name resolution rules. All provided tables must exist, or an error is returned.

options - Optional parameters.

• NO_ERROR_IF_NOT_EXISTS: If TRUE and if the table names specified in tableNames does not exist, no error is returned. If FALSE and if the table names specified in tableNames does not exist, then an error is 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.

getTableNames

public List<String> getTableNames()

Names of tables whose metadata will be fetched, each in [schema_name.]table_name format, using standard name resolution rules. All provided tables must exist, or an error is returned.

Returns:

The current value of tableNames.

setTableNames

public ShowStatisticsRequest setTableNames(List<String> tableNames)

Names of tables whose metadata will be fetched, each in [schema_name.]table_name format, using standard name resolution rules. All provided tables must exist, or an error is returned.

Parameters:

tableNames - The new value for tableNames.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Optional parameters.

• NO_ERROR_IF_NOT_EXISTS: If TRUE and if the table names specified in tableNames does not exist, no error is returned. If FALSE and if the table names specified in tableNames does not exist, then an error is 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 ShowStatisticsRequest setOptions(Map<String,String> options)

Optional parameters.

• NO_ERROR_IF_NOT_EXISTS: If TRUE and if the table names specified in tableNames does not exist, no error is returned. If FALSE and if the table names specified in tableNames does not exist, then an error is 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