Skip to main content

  • Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as delete_records.

    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)

    ​
    Parameters

    • table_name: string

      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.

    • Optionaloffset: number

      A positive integer indicating the number of initial results to skip (this can be useful for paging through the results).

    • Optionallimit: number

      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.

    • Optionaloptions: Record<string, string>
    • Optionalcallback: GPUdbCallback

      Optional callback function

    ​
    Returns Promise<GetRecordsFromCollectionResponse>

    Promise<Types.GetRecordsFromCollectionResponse> - Promise resolving to the response