collect.data_request: Retrieve a database query

In galah: Biodiversity Data from the GBIF Node Network

Retrieve a database query

Description

Retrieve the result of a query from the server. It is the default way to end a piped query that begins with galah_call().

Usage

## S3 method for class 'data_request'
collect(x, ..., wait = TRUE, file = NULL)

## S3 method for class 'metadata_request'
collect(x, ...)

## S3 method for class 'files_request'
collect(x, ...)

## S3 method for class 'prequery'
collect(x, ...)

## S3 method for class 'query'
collect(x, ...)

## S3 method for class 'query_set'
collect(x, ..., wait = TRUE, file = NULL)

## S3 method for class 'computed_query'
collect(x, ..., wait = TRUE, file = NULL)

Arguments

x	An object of class data_request, metadata_request or files_request (from galah_call()); or an object of class prequery, query_set or query (from capture(), collapse() or compute())
...	Arguments passed on to other methods
wait	logical; should galah wait for a response? Defaults to FALSE. Only applies for type = "occurrences" or "species".
file	(Optional) file name. If not given, will be set to data with date and time added. The file path (directory) is always given by galah_config()$package$directory.

Details

galah uses an object-based pipeline to convert piped requests into valid queries, and to enact those queries with the specified organisation. Typically, requests open with galah_call() - though request_metadata() and request_files() are also valid - and end with collect(). Under the hood, the sequence of functions is as follows:

capture() → compound() → collapse() → compute() → collect()

collect() is the final step of the galah_call() workflow, and it retrieves the result of a query once it is processed by the server.

Value

In most cases, collect() returns a tibble containing requested data. Where the requested data are not yet ready (i.e. for occurrences when wait is set to FALSE), this function returns an object of class query that can be used to recheck the download at a later time.

See Also

To open a piped query, see galah_call(). For alternative operations on ⁠_request⁠ objects, see capture(), compound(), collapse() or compute().

galah documentation built on Feb. 11, 2026, 9:11 a.m.