Skip to main content

[DEPRECATED] Retrieve records from a collection, optionally returning the record IDs

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.

The records are decoded by the types the server names, as known to this client or else read from the server.

  • table_name - 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).
  • 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.

[DEPRECATED] Retrieve records from a collection, optionally returning the record IDs

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.

The records are decoded by the types the server names, as known to this client or else read from the server.

  • table_name - 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).
  • 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.
  • options - The optional parameters; any left unset take the server’s defaults.

Sends a pre-built GetRecordsFromCollectionRequest to the /get/records/fromcollection endpoint and decodes the records it returns, by record_type if given, else by the types the server names. Only binary encoding is supported.

Sends a pre-built GetRecordsFromCollectionRequest to the /get/records/fromcollection endpoint, returning the response as the server sends it.

Sends a pre-built GetRecordsFromCollectionRequest to a specific worker URL, bypassing HA head-node selection. Used for multi-head access.