Package com.gpudb.protocol

Class GetRecordsByColumnRequest

  • All Implemented Interfaces:
    org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
    public class GetRecordsByColumnRequest
extends Object
implements org.apache.avro.generic.IndexedRecord
    A set of parameters for GPUdb.getRecordsByColumn.

    For a given table, retrieves the values from the requested column(s). Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.

    Window functions, which can perform operations like moving averages, are available through this endpoint as well as GPUdb.createProjection.

    When using pagination, if the table (or the underlying table in the case of a view) is modified (records are inserted, updated, or deleted) during a call to the endpoint, the records or values retrieved may differ between calls based on the type of the update, e.g., the contiguity across pages cannot be relied upon.

    If tableName is empty, selection is performed against a single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).

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

    • Constructor Detail

      • GetRecordsByColumnRequest

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

      • GetRecordsByColumnRequest

        public GetRecordsByColumnRequest​(String tableName,
                                 List<String> columnNames,
                                 long offset,
                                 long limit,
                                 Map<String,​String> options)
        Constructs a GetRecordsByColumnRequest object with the specified parameters.
        Parameters:
        tableName - Name of the table or view on which this operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions.
        columnNames - The list of column values to retrieve.
        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 - The default value is an empty Map.

      • GetRecordsByColumnRequest

        public GetRecordsByColumnRequest​(String tableName,
                                 List<String> columnNames,
                                 long offset,
                                 long limit,
                                 String encoding,
                                 Map<String,​String> options)
        Constructs a GetRecordsByColumnRequest object with the specified parameters.
        Parameters:
        tableName - Name of the table or view on which this operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions.
        columnNames - The list of column values to retrieve.
        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; either BINARY or JSON. Supported values: The default value is BINARY.
        options - 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()
        Name of the table or view on which this operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions.
        Returns:
        The current value of tableName.

      • setTableName

        public GetRecordsByColumnRequest setTableName​(String tableName)
        Name of the table or view on which this operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions.
        Parameters:
        tableName - The new value for tableName.
        Returns:
        this to mimic the builder pattern.

      • getColumnNames

        public List<String> getColumnNames()
        The list of column values to retrieve.
        Returns:
        The current value of columnNames.

      • setColumnNames

        public GetRecordsByColumnRequest setColumnNames​(List<String> columnNames)
        The list of column values to retrieve.
        Parameters:
        columnNames - The new value for columnNames.
        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 GetRecordsByColumnRequest 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 GetRecordsByColumnRequest 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; either BINARY or JSON. Supported values: The default value is BINARY.
        Returns:
        The current value of encoding.

      • setEncoding

        public GetRecordsByColumnRequest setEncoding​(String encoding)
        Specifies the encoding for returned records; either BINARY or JSON. Supported values: 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()
        The default value is an empty Map.
        Returns:
        The current value of options.

      • 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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object