api-project.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/bq-project.R
\name{api-project}
\alias{api-project}
\alias{bq_project_datasets}
\alias{bq_project_jobs}
\title{BigQuery project methods}
\usage{
bq_project_datasets(x, page_size = 100, max_pages = 1, warn = TRUE)

bq_project_jobs(x, page_size = 100, max_pages = 1, warn = TRUE)
}
\arguments{
\item{x}{A string giving a project name.}

\item{page_size}{Number of items per page.}

\item{max_pages}{Maximum number of pages to retrieve. Use \code{Inf} to retrieve
all pages (this may take a long time!)}

\item{warn}{If \code{TRUE}, warn when there are unretrieved pages.}
}
\value{
\itemize{
\item \code{bq_project_datasets()}: a list of \link{bq_dataset}s
\item \code{bq_project_jobs()}: a list of \link{bq_job}s.
}
}
\description{
Projects have two primary components: datasets and jobs. Unlike other
BigQuery objects, is no accompanying \code{bq_project} S3 class because a project
is a simple string.
}
\section{Google BigQuery API documentation}{

\itemize{
\item \href{https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets/list}{datasets}
\item \href{https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/list}{jobs}
}

One day we might also expose the general \href{https://cloud.google.com/resource-manager/reference/rest/v1/projects}{project metadata}.
}

\examples{
\dontshow{if (bq_testable()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
bq_project_datasets("bigquery-public-data")
bq_project_datasets("githubarchive")

bq_project_jobs(bq_test_project(), page_size = 10)
\dontshow{\}) # examplesIf}
}