Basic create-read-update-delete verbs for tables, as well as functions
uploading data (bq_table_upload()), saving to/loading from Google
Cloud Storage (bq_table_load(), bq_table_save()), and getting
various values from the metadata.
Usage
bq_table_create(x, fields = NULL, ...)
bq_table_meta(x, fields = NULL)
bq_table_fields(x)
bq_table_size(x)
bq_table_nrow(x)
bq_table_exists(x)
bq_table_delete(x)
bq_table_copy(x, dest, ..., quiet = NA)
bq_table_upload(x, values, ..., quiet = NA)
bq_table_save(x, destination_uris, ..., quiet = NA)
bq_table_load(x, source_uris, ..., quiet = NA)
bq_table_patch(x, fields)Arguments
- x
A bq_table, or an object coercible to a
bq_table.- fields
A bq_fields specification, or something coercible to it (like a data frame).
- ...
Additional arguments passed on to the underlying API call. snake_case names are automatically converted to camelCase.
- dest
Source and destination bq_tables.
- quiet
If
FALSE, displays progress bar; ifTRUEis silent; ifNApicks based on whether or not you're in an interactive context.- values
Data frame of values to insert.
- destination_uris
A character vector of fully-qualified Google Cloud Storage URIs where the extracted table should be written. Can export up to 1 Gb of data per file. Use a wild card URI (e.g.
gs://[YOUR_BUCKET]/file-name-*.json) to automatically create any number of files.- source_uris
The fully-qualified URIs that point to your data in Google Cloud.
For Google Cloud Storage URIs: Each URI can contain one `'*'`` wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources.
For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '*' wildcard character is not allowed.
Examples
ds <- bq_test_dataset()
bq_mtcars <- bq_table(ds, "mtcars")
bq_table_exists(bq_mtcars)
#> [1] FALSE
bq_table_create(
bq_mtcars,
fields = mtcars,
friendly_name = "Motor Trend Car Road Tests",
description = "The data was extracted from the 1974 Motor Trend US magazine",
labels = list(category = "example")
)
#> <bq_table> gargle-169921.TESTING_jcfdjagfvs.mtcars
bq_table_exists(bq_mtcars)
#> [1] TRUE
bq_table_upload(bq_mtcars, mtcars)
bq_table_fields(bq_mtcars)
#> <bq_fields>
#> mpg <FLOAT>
#> cyl <FLOAT>
#> disp <FLOAT>
#> hp <FLOAT>
#> drat <FLOAT>
#> wt <FLOAT>
#> qsec <FLOAT>
#> vs <FLOAT>
#> am <FLOAT>
#> gear <FLOAT>
#> carb <FLOAT>
#>
bq_table_size(bq_mtcars)
#> 2.82 kB
str(bq_table_meta(bq_mtcars))
#> List of 19
#> $ kind : chr "bigquery#table"
#> $ etag : chr "1lOEA9w0Dy25/afbVOVNFw=="
#> $ id : chr "gargle-169921:TESTING_jcfdjagfvs.mtcars"
#> $ selfLink : chr "https://bigquery.googleapis.com/bigquery/v2/projects/gargle-169921/datasets/TESTING_jcfdjagfvs/tables/mtcars"
#> $ tableReference :List of 3
#> ..$ projectId: chr "gargle-169921"
#> ..$ datasetId: chr "TESTING_jcfdjagfvs"
#> ..$ tableId : chr "mtcars"
#> $ friendlyName : chr "Motor Trend Car Road Tests"
#> $ description : chr "The data was extracted from the 1974 Motor Trend US magazine"
#> $ labels :List of 1
#> ..$ category: chr "example"
#> $ schema :List of 1
#> ..$ fields:List of 11
#> .. ..$ :List of 4
#> .. .. ..$ name : chr "mpg"
#> .. .. ..$ type : chr "FLOAT"
#> .. .. ..$ mode : chr "NULLABLE"
#> .. .. ..$ description: chr ""
#> .. ..$ :List of 4
#> .. .. ..$ name : chr "cyl"
#> .. .. ..$ type : chr "FLOAT"
#> .. .. ..$ mode : chr "NULLABLE"
#> .. .. ..$ description: chr ""
#> .. ..$ :List of 4
#> .. .. ..$ name : chr "disp"
#> .. .. ..$ type : chr "FLOAT"
#> .. .. ..$ mode : chr "NULLABLE"
#> .. .. ..$ description: chr ""
#> .. ..$ :List of 4
#> .. .. ..$ name : chr "hp"
#> .. .. ..$ type : chr "FLOAT"
#> .. .. ..$ mode : chr "NULLABLE"
#> .. .. ..$ description: chr ""
#> .. ..$ :List of 4
#> .. .. ..$ name : chr "drat"
#> .. .. ..$ type : chr "FLOAT"
#> .. .. ..$ mode : chr "NULLABLE"
#> .. .. ..$ description: chr ""
#> .. ..$ :List of 4
#> .. .. ..$ name : chr "wt"
#> .. .. ..$ type : chr "FLOAT"
#> .. .. ..$ mode : chr "NULLABLE"
#> .. .. ..$ description: chr ""
#> .. ..$ :List of 4
#> .. .. ..$ name : chr "qsec"
#> .. .. ..$ type : chr "FLOAT"
#> .. .. ..$ mode : chr "NULLABLE"
#> .. .. ..$ description: chr ""
#> .. ..$ :List of 4
#> .. .. ..$ name : chr "vs"
#> .. .. ..$ type : chr "FLOAT"
#> .. .. ..$ mode : chr "NULLABLE"
#> .. .. ..$ description: chr ""
#> .. ..$ :List of 4
#> .. .. ..$ name : chr "am"
#> .. .. ..$ type : chr "FLOAT"
#> .. .. ..$ mode : chr "NULLABLE"
#> .. .. ..$ description: chr ""
#> .. ..$ :List of 4
#> .. .. ..$ name : chr "gear"
#> .. .. ..$ type : chr "FLOAT"
#> .. .. ..$ mode : chr "NULLABLE"
#> .. .. ..$ description: chr ""
#> .. ..$ :List of 4
#> .. .. ..$ name : chr "carb"
#> .. .. ..$ type : chr "FLOAT"
#> .. .. ..$ mode : chr "NULLABLE"
#> .. .. ..$ description: chr ""
#> $ numBytes : chr "2816"
#> $ numLongTermBytes : chr "0"
#> $ numRows : chr "32"
#> $ creationTime : chr "1710438007681"
#> $ lastModifiedTime : chr "1710438010201"
#> $ type : chr "TABLE"
#> $ location : chr "US"
#> $ numTotalLogicalBytes : chr "2816"
#> $ numActiveLogicalBytes : chr "2816"
#> $ numLongTermLogicalBytes: chr "0"
bq_table_delete(bq_mtcars)
bq_table_exists(bq_mtcars)
#> [1] FALSE
my_natality <- bq_table(ds, "mynatality")
bq_table_copy("publicdata.samples.natality", my_natality)
#> <bq_table> gargle-169921.TESTING_jcfdjagfvs.mynatality