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.IndexedRecordA set of parameters for
GPUdb.showStatistics.
Retrieves the collected column statistics for the specified table(s).
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA set of string constants for theShowStatisticsRequestparameteroptions.Constructor Summary
ConstructorsConstructorDescriptionConstructs a ShowStatisticsRequest object with default parameters.Constructs a ShowStatisticsRequest object with the specified parameters.Method Summary
Modifier and TypeMethodDescriptionbooleanget(int index) This method supports the Avro framework and is not intended to be called directly by the user.static org.apache.avro.SchemaThis method supports the Avro framework and is not intended to be called directly by the user.Optional parameters.org.apache.avro.SchemaThis method supports the Avro framework and is not intended to be called directly by the user.Names of tables whose metadata will be fetched, each in [schema_name.]table_name format, using standard name resolution rules.inthashCode()voidThis method supports the Avro framework and is not intended to be called directly by the user.setOptions(Map<String, String> options) Optional parameters.setTableNames(List<String> tableNames) Names of tables whose metadata will be fetched, each in [schema_name.]table_name format, using standard name resolution rules.toString()
Constructor Details
ShowStatisticsRequest
public ShowStatisticsRequest()Constructs a ShowStatisticsRequest object with default parameters.ShowStatisticsRequest
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. A single entry of ’*’ expands to every user table the caller may read (excluding system schemas, views, and temporary tables); when used it must be the only entry.options- Optional parameters.NO_ERROR_IF_NOT_EXISTS: IfTRUEand if the table names specified intableNamesdoes not exist, no error is returned. IfFALSEand if the table names specified intableNamesdoes not exist, then an error is returned. Supported values:The default value isFALSE.COLUMN_NAMES: Columns, per table intableNames, to collect statistics for when @input.key options.collect_now isTRUE; ignored otherwise. Encoded as a ’;‘-separated parallel array aligned withtableNames(e.g. ‘x,y;z’ requests columns x,y for the first table and z for the second). A value of ’*’ expands to every collectable column on each table (geometry, vector, JSON, and array columns are skipped). An explicit list may not be combined with a ’*’ table_names wildcard. The default value is ”.COLLECT_NOW: IfTRUE, the columns named by
Method Details
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
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. A single entry of ’*’ expands to every user table the caller may read (excluding system schemas, views, and temporary tables); when used it must be the only entry.Returns:The current value oftableNames.setTableNames
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. A single entry of ’*’ expands to every user table the caller may read (excluding system schemas, views, and temporary tables); when used it must be the only entry.Parameters:tableNames- The new value fortableNames.Returns:thisto mimic the builder pattern.getOptions
Optional parameters.NO_ERROR_IF_NOT_EXISTS: IfTRUEand if the table names specified intableNamesdoes not exist, no error is returned. IfFALSEand if the table names specified intableNamesdoes not exist, then an error is returned. Supported values:The default value isFALSE.COLUMN_NAMES: Columns, per table intableNames, to collect statistics for when @input.key options.collect_now isTRUE; ignored otherwise. Encoded as a ’;‘-separated parallel array aligned withtableNames(e.g. ‘x,y;z’ requests columns x,y for the first table and z for the second). A value of ’*’ expands to every collectable column on each table (geometry, vector, JSON, and array columns are skipped). An explicit list may not be combined with a ’*’ table_names wildcard. The default value is ”.COLLECT_NOW: IfTRUE, the columns named by @input.key options.column_names are collected synchronously during this request and reflected in the response. Supported values:The default value isFALSE.
Map.Returns:The current value ofoptions.setOptions
Optional parameters.NO_ERROR_IF_NOT_EXISTS: IfTRUEand if the table names specified intableNamesdoes not exist, no error is returned. IfFALSEand if the table names specified intableNamesdoes not exist, then an error is returned. Supported values:The default value isFALSE.COLUMN_NAMES: Columns, per table intableNames, to collect statistics for when @input.key options.collect_now isTRUE; ignored otherwise. Encoded as a ’;‘-separated parallel array aligned withtableNames(e.g. ‘x,y;z’ requests columns x,y for the first table and z for the second). A value of ’*’ expands to every collectable column on each table (geometry, vector, JSON, and array columns are skipped). An explicit list may not be combined with a ’*’ table_names wildcard. The default value is ”.COLLECT_NOW: IfTRUE, the columns named by @input.key options.column_names are collected synchronously during this request and reflected in the response. Supported values:The default value isFALSE.
Map.Parameters:options- The new value foroptions.Returns:thisto 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:getSchemain interfaceorg.apache.avro.generic.GenericContainerReturns:The schema object describing this class.get
This method supports the Avro framework and is not intended to be called directly by the user.Specified by:getin interfaceorg.apache.avro.generic.IndexedRecordParameters:index- the position of the field to getReturns:value of the field with the given index.Throws:put
This method supports the Avro framework and is not intended to be called directly by the user.Specified by:putin interfaceorg.apache.avro.generic.IndexedRecordParameters:index- the position of the field to setvalue- the value to setThrows: