BigQuery API v2
This documentation has been automatically generated using information supplied by the Google API Discovery service.
1 API Parameters
procedure
(_ [ #:alt alt #:fields fields #:key key #:oauth_token oauth_token #:prettyPrint prettyPrint #:quotaUser quotaUser #:userIp userIp]) → jsexpr? alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
This is not actually a function. This is just using Scribble’s defproc form to list the optional keyword arguments that may be passed to all functions for this service.
fields: Selector specifying which fields to include in a partial response.
key: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
oauth_token: OAuth 2.0 token for the current user.
prettyPrint: Returns response with indentations and line breaks.
quotaUser: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
userIp: IP address of the site where the request originates. Use this if you want to enforce per-user limits.
2 Resources
2.1 datasets
procedure
projectId : string? maxResults : string? = 'N/A pageToken : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
projectId: Project ID of the datasets to be listed
maxResults: The maximum number of results to return
pageToken: Page token, returned by a previous call, to request the next page of results
procedure
datasetId : string? projectId : string? alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
datasetId: Dataset ID of the requested dataset
projectId: Project ID of the requested dataset
procedure
→ jsexpr? projectId : string? id : string? = 'N/A description : string? = 'N/A kind : string? = 'N/A selfLink : string? = 'N/A access : string? = 'N/A creationTime : string? = 'N/A datasetReference : string? = 'N/A etag : string? = 'N/A friendlyName : string? = 'N/A lastModifiedTime : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
projectId: Project ID of the new dataset
id: [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
description: [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.
kind: [Output-only] The resource type.
selfLink: [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.
access: [Optional] Describes users’ rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user. Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above. To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role. Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
creationTime: [Output-only] The time when this dataset was created, in milliseconds since the epoch.
datasetReference: [Required] Reference identifying dataset.
etag: [Output-only] A hash of this resource.
friendlyName: [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.
lastModifiedTime: [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
procedure
→ jsexpr? datasetId : string? projectId : string? id : string? = 'N/A description : string? = 'N/A kind : string? = 'N/A selfLink : string? = 'N/A access : string? = 'N/A creationTime : string? = 'N/A datasetReference : string? = 'N/A etag : string? = 'N/A friendlyName : string? = 'N/A lastModifiedTime : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
datasetId: Dataset ID of the dataset being updated
projectId: Project ID of the dataset being updated
id: [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
description: [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.
kind: [Output-only] The resource type.
selfLink: [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.
access: [Optional] Describes users’ rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user. Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above. To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role. Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
creationTime: [Output-only] The time when this dataset was created, in milliseconds since the epoch.
datasetReference: [Required] Reference identifying dataset.
etag: [Output-only] A hash of this resource.
friendlyName: [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.
lastModifiedTime: [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
procedure
→ jsexpr? datasetId : string? projectId : string? id : string? = 'N/A description : string? = 'N/A kind : string? = 'N/A selfLink : string? = 'N/A access : string? = 'N/A creationTime : string? = 'N/A datasetReference : string? = 'N/A etag : string? = 'N/A friendlyName : string? = 'N/A lastModifiedTime : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
datasetId: Dataset ID of the dataset being updated
projectId: Project ID of the dataset being updated
id: [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
description: [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.
kind: [Output-only] The resource type.
selfLink: [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.
access: [Optional] Describes users’ rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user. Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above. To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role. Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
creationTime: [Output-only] The time when this dataset was created, in milliseconds since the epoch.
datasetReference: [Required] Reference identifying dataset.
etag: [Output-only] A hash of this resource.
friendlyName: [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.
lastModifiedTime: [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
procedure
→ jsexpr? datasetId : string? projectId : string? deleteContents : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
datasetId: Dataset ID of dataset being deleted
projectId: Project ID of the dataset being deleted
deleteContents: If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False
2.2 jobs
procedure
projectId : string? projection : string? = 'N/A maxResults : string? = 'N/A pageToken : string? = 'N/A allUsers : string? = 'N/A stateFilter : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
projectId: Project ID of the jobs to list
projection: Restrict information returned to a set of selected fields
maxResults: Maximum number of results to return
pageToken: Page token, returned by a previous call, to request the next page of results
allUsers: Whether to display jobs owned by all users in the project. Default false
stateFilter: Filter for job state
procedure
(bigquery-jobs-get #:projectId projectId #:jobId jobId [ #:alt alt #:fields fields #:key key #:oauth_token oauth_token #:prettyPrint prettyPrint #:quotaUser quotaUser #:userIp userIp]) → jsexpr? projectId : string? jobId : string? alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
projectId: Project ID of the requested job
jobId: Job ID of the requested job
procedure
projectId : string? id : string? = 'N/A kind : string? = 'N/A selfLink : string? = 'N/A etag : string? = 'N/A jobReference : string? = 'N/A configuration : string? = 'N/A statistics : string? = 'N/A status : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
projectId: Project ID of the project that will be billed for the job
id: [Output-only] Opaque ID field of the job
kind: [Output-only] The type of the resource.
selfLink: [Output-only] A URL that can be used to access this resource again.
etag: [Output-only] A hash of this resource.
jobReference: [Optional] Reference describing the unique-per-user name of the job.
configuration: [Required] Describes the job configuration.
statistics: [Output-only] Information about the job, including starting time and ending time of the job.
status: [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
procedure
projectId : string? kind : string? = 'N/A query : string? = 'N/A maxResults : string? = 'N/A defaultDataset : string? = 'N/A dryRun : string? = 'N/A timeoutMs : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
projectId: Project ID of the project billed for the query
kind: The resource type of the request.
query: [Required] A query string, following the BigQuery query syntax of the query to execute. Table names should be qualified by dataset name in the format projectId:datasetId.tableId unless you specify the defaultDataset value. If the table is in the same project as the job, you can omit the project ID. Example: SELECT f1 FROM myProjectId:myDatasetId.myTableId.
maxResults: [Optional] The maximum number of results to return per page of results. If the response list exceeds the maximum response size for a single response, you will have to page through the results. Default is to return the maximum response size.
defaultDataset: [Optional] Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be fully-qualified in the format projectId:datasetId.tableid.
dryRun: [Optional] If set, don’t actually run the query. A valid query will return an empty response, while an invalid query will return the same error it would if it wasn’t a dry run.
timeoutMs: [Optional] How long to wait for the query to complete, in milliseconds, before returning. Default is to return immediately. If the timeout passes before the job completes, the request will fail with a TIMEOUT error.
procedure
→ jsexpr? projectId : string? jobId : string? startIndex : string? = 'N/A maxResults : string? = 'N/A timeoutMs : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
projectId: Project ID of the query job
jobId: Job ID of the query job
startIndex: Zero-based index of the starting row
maxResults: Maximum number of results to read
timeoutMs: How long to wait for the query to complete, in milliseconds, before returning. Default is to return immediately. If the timeout passes before the job completes, the request will fail with a TIMEOUT error
2.3 projects
procedure
maxResults : string? = 'N/A pageToken : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
maxResults: Maximum number of results to return
pageToken: Page token, returned by a previous call, to request the next page of results
2.4 tables
procedure
datasetId : string? projectId : string? maxResults : string? = 'N/A pageToken : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
datasetId: Dataset ID of the tables to list
projectId: Project ID of the tables to list
maxResults: Maximum number of results to return
pageToken: Page token, returned by a previous call, to request the next page of results
procedure
tableId : string? datasetId : string? projectId : string? alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
tableId: Table ID of the requested table
datasetId: Dataset ID of the requested table
projectId: Project ID of the requested table
procedure
→ jsexpr? datasetId : string? projectId : string? id : string? = 'N/A schema : string? = 'N/A description : string? = 'N/A kind : string? = 'N/A selfLink : string? = 'N/A creationTime : string? = 'N/A etag : string? = 'N/A friendlyName : string? = 'N/A lastModifiedTime : string? = 'N/A expirationTime : string? = 'N/A numBytes : string? = 'N/A numRows : string? = 'N/A tableReference : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
datasetId: Dataset ID of the new table
projectId: Project ID of the new table
id: [Output-only] An opaque ID uniquely identifying the table.
schema: [Optional] Describes the schema of this table.
description: [Optional] A user-friendly description of this table.
kind: [Output-only] The type of the resource.
selfLink: [Output-only] A URL that can be used to access this resource again.
creationTime: [Output-only] The time when this table was created, in milliseconds since the epoch.
etag: [Output-only] A hash of this resource.
friendlyName: [Optional] A descriptive name for this table.
lastModifiedTime: [Output-only] The time when this table was last modified, in milliseconds since the epoch.
expirationTime: [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.
numBytes: [Output-only] The size of the table in bytes.
numRows: [Output-only] The number of rows of data in this table.
tableReference: [Required] Reference describing the ID of this table.
procedure
→ jsexpr? tableId : string? datasetId : string? projectId : string? id : string? = 'N/A schema : string? = 'N/A description : string? = 'N/A kind : string? = 'N/A selfLink : string? = 'N/A creationTime : string? = 'N/A etag : string? = 'N/A friendlyName : string? = 'N/A lastModifiedTime : string? = 'N/A expirationTime : string? = 'N/A numBytes : string? = 'N/A numRows : string? = 'N/A tableReference : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
tableId: Table ID of the table to update
datasetId: Dataset ID of the table to update
projectId: Project ID of the table to update
id: [Output-only] An opaque ID uniquely identifying the table.
schema: [Optional] Describes the schema of this table.
description: [Optional] A user-friendly description of this table.
kind: [Output-only] The type of the resource.
selfLink: [Output-only] A URL that can be used to access this resource again.
creationTime: [Output-only] The time when this table was created, in milliseconds since the epoch.
etag: [Output-only] A hash of this resource.
friendlyName: [Optional] A descriptive name for this table.
lastModifiedTime: [Output-only] The time when this table was last modified, in milliseconds since the epoch.
expirationTime: [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.
numBytes: [Output-only] The size of the table in bytes.
numRows: [Output-only] The number of rows of data in this table.
tableReference: [Required] Reference describing the ID of this table.
procedure
→ jsexpr? tableId : string? datasetId : string? projectId : string? id : string? = 'N/A schema : string? = 'N/A description : string? = 'N/A kind : string? = 'N/A selfLink : string? = 'N/A creationTime : string? = 'N/A etag : string? = 'N/A friendlyName : string? = 'N/A lastModifiedTime : string? = 'N/A expirationTime : string? = 'N/A numBytes : string? = 'N/A numRows : string? = 'N/A tableReference : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
tableId: Table ID of the table to update
datasetId: Dataset ID of the table to update
projectId: Project ID of the table to update
id: [Output-only] An opaque ID uniquely identifying the table.
schema: [Optional] Describes the schema of this table.
description: [Optional] A user-friendly description of this table.
kind: [Output-only] The type of the resource.
selfLink: [Output-only] A URL that can be used to access this resource again.
creationTime: [Output-only] The time when this table was created, in milliseconds since the epoch.
etag: [Output-only] A hash of this resource.
friendlyName: [Optional] A descriptive name for this table.
lastModifiedTime: [Output-only] The time when this table was last modified, in milliseconds since the epoch.
expirationTime: [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.
numBytes: [Output-only] The size of the table in bytes.
numRows: [Output-only] The number of rows of data in this table.
tableReference: [Required] Reference describing the ID of this table.
procedure
tableId : string? datasetId : string? projectId : string? alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
tableId: Table ID of the table to delete
datasetId: Dataset ID of the table to delete
projectId: Project ID of the table to delete
2.5 tabledata
procedure
tableId : string? datasetId : string? projectId : string? startIndex : string? = 'N/A maxResults : string? = 'N/A pageToken : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
tableId: Table ID of the table to read
datasetId: Dataset ID of the table to read
projectId: Project ID of the table to read
startIndex: Zero-based index of the starting row to read
maxResults: Maximum number of results to return
pageToken: Page token, returned by a previous call, identifying the result set