AggregateUniqueRequest

java.lang.Object

com.gpudb.protocol.AggregateUniqueRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.aggregateUnique.

Returns all the unique values from a particular column (specified by columnName) of a particular table or view (specified by tableName). If columnName is a numeric column, the values will be in data. Otherwise if columnName is a string column, the values will be in jsonEncodedResponse. The results can be paged via offset and limit parameters.

“limit”:“10”,“sort_order”:“descending”

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

If a RESULT_TABLE name is specified in the options, the results are stored in a new table with that name—no results are returned in the response. Both the table name and resulting column name must adhere to standard naming conventions; any column expression will need to be aliased. If the source table’s shard key is used as the columnName, the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available if the value of columnName is an unrestricted-length string.

Nested Class Summary
Nested Classes
Modifier and Type
Class
Description
static final class
AggregateUniqueRequest.Encoding
A set of string constants for the AggregateUniqueRequest parameter encoding.
static final class
AggregateUniqueRequest.Options
A set of string constants for the AggregateUniqueRequest parameter options.
Constructor Summary
Constructors
Constructor
Description
AggregateUniqueRequest()
Constructs an AggregateUniqueRequest object with default parameters.
AggregateUniqueRequest(String tableName, String columnName, long offset, long limit, String encoding, Map<String,String> options)
Constructs an AggregateUniqueRequest object with the specified parameters.
AggregateUniqueRequest(String tableName, String columnName, long offset, long limit, Map<String,String> options)
Constructs an AggregateUniqueRequest 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.
String
getColumnName()
Name of the column or an expression containing one or more column names on which the unique function would be applied.
String
getEncoding()
Specifies the encoding for returned records.
long
getLimit()
A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned.
long
getOffset()
A positive integer indicating the number of initial results to skip (this can be useful for paging through the results).
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 an existing table or view on which the operation will be performed, 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.
AggregateUniqueRequest
setColumnName(String columnName)
Name of the column or an expression containing one or more column names on which the unique function would be applied.
AggregateUniqueRequest
setEncoding(String encoding)
Specifies the encoding for returned records.
AggregateUniqueRequest
setLimit(long limit)
A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned.
AggregateUniqueRequest
setOffset(long offset)
A positive integer indicating the number of initial results to skip (this can be useful for paging through the results).
AggregateUniqueRequest
setOptions(Map<String,String> options)
Optional parameters.
AggregateUniqueRequest
setTableName(String tableName)
Name of an existing table or view on which the operation will be performed, 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 Details
- AggregateUniqueRequest
  public AggregateUniqueRequest()
  Constructs an AggregateUniqueRequest object with default parameters.
- AggregateUniqueRequest
  public AggregateUniqueRequest(String tableName, String columnName, long offset, long limit, Map<String,String> options)
  Constructs an AggregateUniqueRequest object with the specified parameters.
  Parameters:
  tableName - Name of an existing table or view on which the operation will be performed, in [schema_name.]table_name format, using standard name resolution rules.
  columnName - Name of the column or an expression containing one or more column names on which the unique function would be applied.
  offset - A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
  limit - A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server’s own limit, defined by the max_get_records_size parameter in the server configuration. Use hasMoreRecords to see if more records exist in the result to be fetched, and offset and limit to request subsequent pages of results. The default value is -9999.
  options - Optional parameters.
  CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of RESULT_TABLE. If RESULT_TABLE_PERSIST is FALSE (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED_RESULT_TABLE_NAME. Supported values:
  TRUE
  FALSE
  The default value is FALSE.
  COLLECTION_NAME: [DEPRECATED—please specify the containing schema as part of RESULT_TABLE and use GPUdb.createSchema to create the schema if non-existent] Name of a schema which is to contain the table specified in RESULT_TABLE. If the schema provided is non-existent, it will be automatically created.
  EXPRESSION: Filter expression to apply to the table.
  SORT_ORDER: String indicating how the returned values should be sorted. Supported values:
  ASCENDING
  DESCENDING
  The default value is ASCENDING.
  ORDER_BY: Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., ‘timestamp asc, x desc’. The default value is ”.
  RESULT_TABLE: The name of the table used to store the results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If present, no results are returned in the response. Not available if columnName is an unrestricted-length string.
  RESULT_TABLE_PERSIST: If TRUE, then the result table specified in RESULT_TABLE will be persisted and will not expire unless a TTL is specified. If FALSE, then the result table will be an in-memory table and will expire unless a TTL is specified otherwise. Supported values:
  TRUE
  FALSE
  The default value is FALSE.
  RESULT_TABLE_FORCE_REPLICATED: Force the result table to be replicated (ignores any sharding). Must be used in combination with the RESULT_TABLE option. Supported values:
  TRUE
  FALSE
  The default value is FALSE.
  RESULT_TABLE_GENERATE_PK: If TRUE then set a primary key for the result table. Must be used in combination with the RESULT_TABLE option. Supported values:
  TRUE
  FALSE
  The default value is FALSE.
  TTL: Sets the TTL of the table specified in RESULT_TABLE.
  CHUNK_SIZE: Indicates the number of records per chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  CHUNK_COLUMN_MAX_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  CHUNK_MAX_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  COMPRESSION_CODEC: The default compression codec for the result table’s columns.
  VIEW_ID: ID of view of which the result table will be a member. The default value is ”.
  The default value is an empty Map.
- AggregateUniqueRequest
  public AggregateUniqueRequest(String tableName, String columnName, long offset, long limit, String encoding, Map<String,String> options)
  Constructs an AggregateUniqueRequest object with the specified parameters.
  Parameters:
  tableName - Name of an existing table or view on which the operation will be performed, in [schema_name.]table_name format, using standard name resolution rules.
  columnName - Name of the column or an expression containing one or more column names on which the unique function would be applied.
  offset - A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
  limit - A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server’s own limit, defined by the max_get_records_size parameter in the server configuration. Use hasMoreRecords to see if more records exist in the result to be fetched, and offset and limit to request subsequent pages of results. The default value is -9999.
  encoding - Specifies the encoding for returned records. Supported values:
  BINARY: Indicates that the returned records should be binary encoded.
  JSON: Indicates that the returned records should be JSON-encoded.
  The default value is BINARY.
  options - Optional parameters.
  CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of RESULT_TABLE. If RESULT_TABLE_PERSIST is FALSE (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED_RESULT_TABLE_NAME. Supported values:
  TRUE
  FALSE
  The default value is FALSE.
  COLLECTION_NAME: [DEPRECATED—please specify the containing schema as part of RESULT_TABLE and use GPUdb.createSchema to create the schema if non-existent] Name of a schema which is to contain the table specified in RESULT_TABLE. If the schema provided is non-existent, it will be automatically created.
  EXPRESSION: Filter expression to apply to the table.
  SORT_ORDER: String indicating how the returned values should be sorted. Supported values:
  ASCENDING
  DESCENDING
  The default value is ASCENDING.
  ORDER_BY: Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., ‘timestamp asc, x desc’. The default value is ”.
  RESULT_TABLE: The name of the table used to store the results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If present, no results are returned in the response. Not available if columnName is an unrestricted-length string.
  RESULT_TABLE_PERSIST: If TRUE, then the result table specified in RESULT_TABLE will be persisted and will not expire unless a TTL is specified. If FALSE, then the result table will be an in-memory table and will expire unless a TTL is specified otherwise. Supported values:
  TRUE
  FALSE
  The default value is FALSE.
  RESULT_TABLE_FORCE_REPLICATED: Force the result table to be replicated (ignores any sharding). Must be used in combination with the RESULT_TABLE option. Supported values:
  TRUE
  FALSE
  The default value is FALSE.
  RESULT_TABLE_GENERATE_PK: If TRUE then set a primary key for the result table. Must be used in combination with the RESULT_TABLE option. Supported values:
  TRUE
  FALSE
  The default value is FALSE.
  TTL: Sets the TTL of the table specified in RESULT_TABLE.
  CHUNK_SIZE: Indicates the number of records per chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  CHUNK_COLUMN_MAX_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  CHUNK_MAX_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  COMPRESSION_CODEC: The default compression codec for the result table’s columns.
  VIEW_ID: ID of view of which the result table will be a member. The default value is ”.
  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 an existing table or view on which the operation will be performed, in [schema_name.]table_name format, using standard name resolution rules.
  Returns:
  The current value of tableName.
- setTableName
  public AggregateUniqueRequest setTableName(String tableName)
  Name of an existing table or view on which the operation will be performed, in [schema_name.]table_name format, using standard name resolution rules.
  Parameters:
  tableName - The new value for tableName.
  Returns:
  this to mimic the builder pattern.
- getColumnName
  public String getColumnName()
  Name of the column or an expression containing one or more column names on which the unique function would be applied.
  Returns:
  The current value of columnName.
- setColumnName
  public AggregateUniqueRequest setColumnName(String columnName)
  Name of the column or an expression containing one or more column names on which the unique function would be applied.
  Parameters:
  columnName - The new value for columnName.
  Returns:
  this to mimic the builder pattern.
- getOffset
  public long getOffset()
  A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
  Returns:
  The current value of offset.
- setOffset
  public AggregateUniqueRequest setOffset(long offset)
  A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
  Parameters:
  offset - The new value for offset.
  Returns:
  this to mimic the builder pattern.
- getLimit
  public long getLimit()
  A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server’s own limit, defined by the max_get_records_size parameter in the server configuration. Use hasMoreRecords to see if more records exist in the result to be fetched, and offset and limit to request subsequent pages of results. The default value is -9999.
  Returns:
  The current value of limit.
- setLimit
  public AggregateUniqueRequest setLimit(long limit)
  A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server’s own limit, defined by the max_get_records_size parameter in the server configuration. Use hasMoreRecords to see if more records exist in the result to be fetched, and offset and limit to request subsequent pages of results. The default value is -9999.
  Parameters:
  limit - The new value for limit.
  Returns:
  this to mimic the builder pattern.
- getEncoding
  public String getEncoding()
  Specifies the encoding for returned records. Supported values:
  BINARY: Indicates that the returned records should be binary encoded.
  JSON: Indicates that the returned records should be JSON-encoded.
  The default value is BINARY.
  Returns:
  The current value of encoding.
- setEncoding
  public AggregateUniqueRequest setEncoding(String encoding)
  Specifies the encoding for returned records. Supported values:
  BINARY: Indicates that the returned records should be binary encoded.
  JSON: Indicates that the returned records should be JSON-encoded.
  The default value is BINARY.
  Parameters:
  encoding - The new value for encoding.
  Returns:
  this to mimic the builder pattern.
- getOptions
  public Map<String,String> getOptions()
  Optional parameters.
  CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of RESULT_TABLE. If RESULT_TABLE_PERSIST is FALSE (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED_RESULT_TABLE_NAME. Supported values:
  TRUE
  FALSE
  The default value is FALSE.
  COLLECTION_NAME: [DEPRECATED—please specify the containing schema as part of RESULT_TABLE and use GPUdb.createSchema to create the schema if non-existent] Name of a schema which is to contain the table specified in RESULT_TABLE. If the schema provided is non-existent, it will be automatically created.
  EXPRESSION: Filter expression to apply to the table.
  SORT_ORDER: String indicating how the returned values should be sorted. Supported values:
  ASCENDING
  DESCENDING
  The default value is ASCENDING.
  ORDER_BY: Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., ‘timestamp asc, x desc’. The default value is ”.
  RESULT_TABLE: The name of the table used to store the results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If present, no results are returned in the response. Not available if columnName is an unrestricted-length string.
  RESULT_TABLE_PERSIST: If TRUE, then the result table specified in RESULT_TABLE will be persisted and will not expire unless a TTL is specified. If FALSE, then the result table will be an in-memory table and will expire unless a TTL is specified otherwise. Supported values:
  TRUE
  FALSE
  The default value is FALSE.
  RESULT_TABLE_FORCE_REPLICATED: Force the result table to be replicated (ignores any sharding). Must be used in combination with the RESULT_TABLE option. Supported values:
  TRUE
  FALSE
  The default value is FALSE.
  RESULT_TABLE_GENERATE_PK: If TRUE then set a primary key for the result table. Must be used in combination with the RESULT_TABLE option. Supported values:
  TRUE
  FALSE
  The default value is FALSE.
  TTL: Sets the TTL of the table specified in RESULT_TABLE.
  CHUNK_SIZE: Indicates the number of records per chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  CHUNK_COLUMN_MAX_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  CHUNK_MAX_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  COMPRESSION_CODEC: The default compression codec for the result table’s columns.
  VIEW_ID: ID of view of which the result table will be a member. The default value is ”.
  The default value is an empty Map.
  Returns:
  The current value of options.
- setOptions
  public AggregateUniqueRequest setOptions(Map<String,String> options)
  Optional parameters.
  CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of RESULT_TABLE. If RESULT_TABLE_PERSIST is FALSE (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED_RESULT_TABLE_NAME. Supported values:
  TRUE
  FALSE
  The default value is FALSE.
  COLLECTION_NAME: [DEPRECATED—please specify the containing schema as part of RESULT_TABLE and use GPUdb.createSchema to create the schema if non-existent] Name of a schema which is to contain the table specified in RESULT_TABLE. If the schema provided is non-existent, it will be automatically created.
  EXPRESSION: Filter expression to apply to the table.
  SORT_ORDER: String indicating how the returned values should be sorted. Supported values:
  ASCENDING
  DESCENDING
  The default value is ASCENDING.
  ORDER_BY: Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., ‘timestamp asc, x desc’. The default value is ”.
  RESULT_TABLE: The name of the table used to store the results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If present, no results are returned in the response. Not available if columnName is an unrestricted-length string.
  RESULT_TABLE_PERSIST: If TRUE, then the result table specified in RESULT_TABLE will be persisted and will not expire unless a TTL is specified. If FALSE, then the result table will be an in-memory table and will expire unless a TTL is specified otherwise. Supported values:
  TRUE
  FALSE
  The default value is FALSE.
  RESULT_TABLE_FORCE_REPLICATED: Force the result table to be replicated (ignores any sharding). Must be used in combination with the RESULT_TABLE option. Supported values:
  TRUE
  FALSE
  The default value is FALSE.
  RESULT_TABLE_GENERATE_PK: If TRUE then set a primary key for the result table. Must be used in combination with the RESULT_TABLE option. Supported values:
  TRUE
  FALSE
  The default value is FALSE.
  TTL: Sets the TTL of the table specified in RESULT_TABLE.
  CHUNK_SIZE: Indicates the number of records per chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  CHUNK_COLUMN_MAX_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  CHUNK_MAX_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  COMPRESSION_CODEC: The default compression codec for the result table’s columns.
  VIEW_ID: ID of view of which the result table will be a member. The default value is ”.
  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

AggregateStatisticsResponse AggregateUniqueRequest.Encoding

⌘I

​Class AggregateUniqueRequest

​Nested Class Summary

​Constructor Summary

​Method Summary

​Methods inherited from class java.lang.Object

​Constructor Details

​AggregateUniqueRequest

​AggregateUniqueRequest

​AggregateUniqueRequest

​Method Details

​getClassSchema

​getTableName

​setTableName

​getColumnName

​setColumnName

​getOffset

​setOffset

​getLimit

​setLimit

​getEncoding

​setEncoding

​getOptions

​setOptions

​getSchema

​get

​put

​equals

​toString

​hashCode

Class AggregateUniqueRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

AggregateUniqueRequest

AggregateUniqueRequest

Method Details

getClassSchema

getTableName

setTableName

getColumnName

setColumnName

getOffset

setOffset

getLimit

setLimit

getEncoding

setEncoding

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode