Skip to main content

  • ​
    getRecordsBySeries

    public <TResponse> GetRecordsBySeriesResponse<TResponse> getRecordsBySeries(Object typeDescriptor, GetRecordsBySeriesRequest request) throws GPUdbException
    Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

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

    In contrast to getRecords this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

    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.

  • ​
    getRecordsBySeries

    public <TResponse> GetRecordsBySeriesResponse<TResponse> getRecordsBySeries(Object typeDescriptor, String tableName, String worldTableName, int offset, int limit, Map<String,String> options) throws GPUdbException
    Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

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

    In contrast to getRecords this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

    Type Parameters:
    TResponse - The type of object being retrieved.
    Parameters:
    typeDescriptor - Type descriptor used for decoding returned objects.
    tableName - Name of the table or view for which series/tracks will be fetched, in [schema_name.]table_name format, using standard name resolution rules.
    worldTableName - Name of the table containing the complete series/track information to be returned for the tracks present in the tableName, in [schema_name.]table_name format, using standard name resolution rules. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.
    offset - A positive integer indicating the number of initial series/tracks to skip (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 series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 250.
    options - Optional parameters. 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.

  • ​
    getRecordsBySeries

    public <TResponse> GetRecordsBySeriesResponse<TResponse> getRecordsBySeries(GetRecordsBySeriesRequest request) throws GPUdbException
    Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

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

    In contrast to getRecords this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

    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.

  • ​
    getRecordsBySeries

    public <TResponse> GetRecordsBySeriesResponse<TResponse> getRecordsBySeries(String tableName, String worldTableName, int offset, int limit, Map<String,String> options) throws GPUdbException
    Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

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

    In contrast to getRecords this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

    Type Parameters:
    TResponse - The type of object being retrieved.
    Parameters:
    tableName - Name of the table or view for which series/tracks will be fetched, in [schema_name.]table_name format, using standard name resolution rules.
    worldTableName - Name of the table containing the complete series/track information to be returned for the tracks present in the tableName, in [schema_name.]table_name format, using standard name resolution rules. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.
    offset - A positive integer indicating the number of initial series/tracks to skip (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 series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 250.
    options - Optional parameters. 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.