diff --git a/DESCRIPTION b/DESCRIPTION index 176a490..6e3d2e2 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -17,7 +17,8 @@ Imports: assertthat, Rcpp, lifecycle, - bit64 + bit64, + tibble Suggests: testthat, bit64, diff --git a/R/bqs_download.R b/R/bqs_download.R index 8fc8f59..b0fda23 100644 --- a/R/bqs_download.R +++ b/R/bqs_download.R @@ -5,7 +5,7 @@ #' @param snapshot_time Snapshot time #' @param selected_fields A character vector of field to select from table. #' @param row_restriction Restriction to apply to the table. -#' @param max_results Maximum number of results to retrieve. Use `Inf` or `-1L` +#' @param n_max Maximum number of results to retrieve. Use `Inf` or `-1L` #' retrieve all rows. #' @param as_tibble Should data be returned as tibble. Default is to return #' as arrow Table from raw IPC stream. @@ -14,6 +14,7 @@ #' 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. +#' @param max_results Deprecated #' @export #' @importFrom arrow RecordBatchStreamReader Table #' @importFrom lifecycle deprecated deprecate_warn diff --git a/man/bqs_table_download.Rd b/man/bqs_table_download.Rd index 1b0e38d..2c6cf0c 100644 --- a/man/bqs_table_download.Rd +++ b/man/bqs_table_download.Rd @@ -29,6 +29,9 @@ grpc method. You can set option `bigquerystorage.project`.} \item{row_restriction}{Restriction to apply to the table.} +\item{n_max}{Maximum number of results to retrieve. Use `Inf` or `-1L` +retrieve all rows.} + \item{quiet}{Should information be printed to console.} \item{as_tibble}{Should data be returned as tibble. Default is to return @@ -39,8 +42,7 @@ The default is `"integer"` which returns R's `integer` type but results in `NA` values above/below +/- 2147483647. `"integer64"` returns a [bit64::integer64], which allows the full range of 64 bit integers.} -\item{max_results}{Maximum number of results to retrieve. Use `Inf` or `-1L` -retrieve all rows.} +\item{max_results}{Deprecated} } \description{ Download table from BigQuery using BigQuery Storage API