bqs_table_download {bigrquerystorage}

Download table data

Description

This retrieves rows block in a stream using a grpc protocol. It is most suitable for results of larger queries (>100 MB, say).

Usage

bqs_table_download(
  x,
  parent = getOption("bigquerystorage.project", ""),
  snapshot_time = NA,
  selected_fields = character(),
  row_restriction = "",
  sample_percentage,
  n_max = Inf,
  quiet = NA,
  as_tibble = FALSE,
  bigint = c("integer", "integer64", "numeric", "character"),
  max_results = lifecycle::deprecated()
)

Arguments

x

Table reference ⁠{project}.{dataset}.{table_name}⁠

parent

Used as parent for CreateReadSession. grpc method. Default is to use option bigquerystorage.project value.

snapshot_time

Table modifier ⁠snapshot time⁠ as POSIXct.

selected_fields

Table read option selected_fields. A character vector of field to select from table.

row_restriction

Table read option row_restriction. A character. SQL text filtering statement.

sample_percentage

Table read option sample_percentage. A numeric ⁠0 <= sample_percentage <= 100⁠. Not compatible with row_restriction.

n_max

Maximum number of results to retrieve. Use Inf or -1L retrieve all rows.

quiet

Should information be printed to console.

as_tibble

Should data be returned as tibble. Default (FALSE) is to return as arrow Table from raw IPC stream.

bigint

The R type that BigQuery's 64-bit integer types should be mapped to. The default is "integer" which returns R's integer type but results in NA for values above/below +/- 2147483647. "integer64" returns a bit64::integer64, which allows the full range of 64 bit integers.

max_results

Deprecated

Details

More details about table modifiers and table options are available from the API Reference documentation. (See TableModifiers and TableReadOptions)

Value

This method returns a arrow::Table Table or optionally a tibble. If you need a data.frame, leave parameter as_tibble to FALSE and coerce the results with as.data.frame().