Skip to main content

  • ​
    getRecordsFromCollection

    public <TResponse> GetRecordsFromCollectionResponse<TResponse> getRecordsFromCollection(Object typeDescriptor, GetRecordsFromCollectionRequest request) throws GPUdbException
    Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.

    This operation supports paging through the data via the offset and limit parameters.

    Note that when using the Java API, it is not possible to retrieve records from join views using this operation. (DEPRECATED)

    Type Parameters:
    TResponse - The type of object being retrieved.
    Parameters:
    typeDescriptor - Type descriptor used for decoding returned objects.
    request - Request object containing the parameters for the operation.
    Returns:
    Response object containing the results of the operation.
    Throws:
    IllegalArgumentException - if typeDescriptor is not an instance of one of the following: Type, TypeObjectMap, Schema, or a Class that implements IndexedRecord
    GPUdbException - if an error occurs during the operation.

  • ​
    getRecordsFromCollection

    public <TResponse> GetRecordsFromCollectionResponse<TResponse> getRecordsFromCollection(Object typeDescriptor, String tableName, long offset, long limit, Map<String,String> options) throws GPUdbException
    Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.

    This operation supports paging through the data via the offset and limit parameters.

    Note that when using the Java API, it is not possible to retrieve records from join views using this operation. (DEPRECATED)

    Type Parameters:
    TResponse - The type of object being retrieved.
    Parameters:
    typeDescriptor - Type descriptor used for decoding returned objects.
    tableName - Name of the collection or table from which records are to be retrieved, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing collection or table.
    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 offset and limit to request subsequent pages of results. The default value is -9999.
    options -
    • RETURN_RECORD_IDS: If TRUE then return the internal record ID along with each returned record. Supported values:The default value is FALSE.
    • EXPRESSION: Filter expression to apply to the table. The default value is ”.
    The default value is an empty Map.
    Returns:
    Response object containing the results of the operation.
    Throws:
    IllegalArgumentException - if typeDescriptor is not an instance of one of the following: Type, TypeObjectMap, Schema, or a Class that implements IndexedRecord
    GPUdbException - if an error occurs during the operation.

  • ​
    getRecordsFromCollection

    public <TResponse> GetRecordsFromCollectionResponse<TResponse> getRecordsFromCollection(GetRecordsFromCollectionRequest request) throws GPUdbException
    Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.

    This operation supports paging through the data via the offset and limit parameters.

    Note that when using the Java API, it is not possible to retrieve records from join views using this operation. (DEPRECATED)

    Type Parameters:
    TResponse - The type of object being retrieved.
    Parameters:
    request - Request object containing the parameters for the operation.
    Returns:
    Response object containing the results of the operation.
    Throws:
    GPUdbException - if an error occurs during the operation.

  • ​
    getRecordsFromCollection

    public <TResponse> GetRecordsFromCollectionResponse<TResponse> getRecordsFromCollection(String tableName, long offset, long limit, Map<String,String> options) throws GPUdbException
    Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.

    This operation supports paging through the data via the offset and limit parameters.

    Note that when using the Java API, it is not possible to retrieve records from join views using this operation. (DEPRECATED)

    Type Parameters:
    TResponse - The type of object being retrieved.
    Parameters:
    tableName - Name of the collection or table from which records are to be retrieved, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing collection or table.
    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 offset and limit to request subsequent pages of results. The default value is -9999.
    options -
    • RETURN_RECORD_IDS: If TRUE then return the internal record ID along with each returned record. Supported values:The default value is FALSE.
    • EXPRESSION: Filter expression to apply to the table. The default value is ”.
    The default value is an empty Map.
    Returns:
    Response object containing the results of the operation.
    Throws:
    GPUdbException - if an error occurs during the operation.