Skip to main content
Package com.gpudb.protocol

​
Class CollectStatisticsRequest

java.lang.Object
com.gpudb.protocol.CollectStatisticsRequest
All Implemented Interfaces:
org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
public class CollectStatisticsRequest extends Object implements org.apache.avro.generic.IndexedRecord
A set of parameters for GPUdb.collectStatistics.

Collect statistics for a column(s) in a specified table.

  • ​
    Constructor Details

    • ​
      CollectStatisticsRequest

      public CollectStatisticsRequest()
      Constructs a CollectStatisticsRequest object with default parameters.

    • ​
      CollectStatisticsRequest

      public CollectStatisticsRequest(String tableName, List<String> columnNames, Map<String,String> options)
      Constructs a CollectStatisticsRequest object with the specified parameters.
      Parameters:
      tableName - Name of a table, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. A value of ’*’ collects statistics on every user table the caller may read (excluding system schemas, views, and temporary tables); when used, columnNames must be ’*‘.
      columnNames - List of one or more column names in tableName for which to collect statistics (cardinality, mean value, etc.). A single entry of ’*’ expands to every collectable column on the table (geometry, vector, JSON, and array columns are skipped).
      options - Optional parameters. The default value is an empty Map.

  • ​
    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.

    • ​
      getTableName

      public String getTableName()
      Name of a table, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. A value of ’*’ collects statistics on every user table the caller may read (excluding system schemas, views, and temporary tables); when used, columnNames must be ’*’.
      Returns:
      The current value of tableName.

    • ​
      setTableName

      public CollectStatisticsRequest setTableName(String tableName)
      Name of a table, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. A value of ’*’ collects statistics on every user table the caller may read (excluding system schemas, views, and temporary tables); when used, columnNames must be ’*’.
      Parameters:
      tableName - The new value for tableName.
      Returns:
      this to mimic the builder pattern.

    • ​
      getColumnNames

      public List<String> getColumnNames()
      List of one or more column names in tableName for which to collect statistics (cardinality, mean value, etc.). A single entry of ’*’ expands to every collectable column on the table (geometry, vector, JSON, and array columns are skipped).
      Returns:
      The current value of columnNames.

    • ​
      setColumnNames

      public CollectStatisticsRequest setColumnNames(List<String> columnNames)
      List of one or more column names in tableName for which to collect statistics (cardinality, mean value, etc.). A single entry of ’*’ expands to every collectable column on the table (geometry, vector, JSON, and array columns are skipped).
      Parameters:
      columnNames - The new value for columnNames.
      Returns:
      this to mimic the builder pattern.

    • ​
      getOptions

      public Map<String,String> getOptions()
      Optional parameters. The default value is an empty Map.
      Returns:
      The current value of options.

    • ​
      setOptions

      public CollectStatisticsRequest setOptions(Map<String,String> options)
      Optional parameters. 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