Google - API BigQuery

DELETE

/projects/{projectId}/datasets/{datasetId}

Deletes the dataset specified by the datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name.

Request

Path

Name	Data Type	Description
`projectId`	string	Project ID of the dataset being deleted
`datasetId`	string	Dataset ID of dataset being deleted

Query

Name	Data Type	Description
`deleteContents`	boolean	If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False

Responses

200Successful response

GET

/projects/{projectId}/datasets/{datasetId}

Returns the dataset specified by datasetID.

Request

Path

Name	Data Type	Description
`projectId`	string	Project ID of the requested dataset
`datasetId`	string	Dataset ID of the requested dataset

Responses

200Successful response

Body

Name Data Type Description

Dataset

Dataset object

Properties


                        access

array [object]

[Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;


                        creationTime

string

[Output-only] The time when this dataset was created, in milliseconds since the epoch.


                        datasetReference

DatasetReference

[Required] A reference that identifies the dataset.

DatasetReference object

Properties

`datasetId`	string	[Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
`projectId`	string	[Optional] The ID of the project containing this dataset.

defaultEncryptionConfiguration EncryptionConfiguration

EncryptionConfiguration object

Properties


                        kmsKeyName

string

[Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.


                        defaultPartitionExpirationMs

string

[Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property.


                        defaultTableExpirationMs

string

[Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.


                        description

string

[Optional] A user-friendly description of the dataset.


                        etag

string

[Output-only] A hash of the resource.


                        friendlyName

string

[Optional] A descriptive name for the dataset.

id

string

[Output-only] The fully-qualified unique name of the 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.


                        kind

string
Default value: bigquery#dataset

[Output-only] The resource type.


                        labels

object

The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information.


                        lastModifiedTime

string

[Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.


                        location

string

The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.


                        selfLink

string

[Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.

PATCH

/projects/{projectId}/datasets/{datasetId}

Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports patch semantics.

Request

Path

Name	Data Type	Description
`projectId`	string	Project ID of the dataset being updated
`datasetId`	string	Dataset ID of the dataset being updated

Body

Name Data Type Description

Dataset

Dataset object

Properties


                        access

array [object]

[Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;


                        creationTime

string

[Output-only] The time when this dataset was created, in milliseconds since the epoch.


                        datasetReference

DatasetReference

[Required] A reference that identifies the dataset.

DatasetReference object

Properties

`datasetId`	string	[Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
`projectId`	string	[Optional] The ID of the project containing this dataset.

defaultEncryptionConfiguration EncryptionConfiguration

EncryptionConfiguration object

Properties


                        kmsKeyName

string

[Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.


                        defaultPartitionExpirationMs

string

[Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property.


                        defaultTableExpirationMs

string

[Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.


                        description

string

[Optional] A user-friendly description of the dataset.


                        etag

string

[Output-only] A hash of the resource.


                        friendlyName

string

[Optional] A descriptive name for the dataset.

id

string

[Output-only] The fully-qualified unique name of the 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.


                        kind

string
Default value: bigquery#dataset

[Output-only] The resource type.


                        labels

object

The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information.


                        lastModifiedTime

string

[Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.


                        location

string

The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.


                        selfLink

string

[Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.

Responses

200Successful response

Body

Name Data Type Description

Dataset

Dataset object

Properties


                        access

array [object]

[Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;


                        creationTime

string

[Output-only] The time when this dataset was created, in milliseconds since the epoch.


                        datasetReference

DatasetReference

[Required] A reference that identifies the dataset.

DatasetReference object

Properties

`datasetId`	string	[Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
`projectId`	string	[Optional] The ID of the project containing this dataset.

defaultEncryptionConfiguration EncryptionConfiguration

EncryptionConfiguration object

Properties


                        kmsKeyName

string

[Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.


                        defaultPartitionExpirationMs

string

[Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property.


                        defaultTableExpirationMs

string

[Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.


                        description

string

[Optional] A user-friendly description of the dataset.


                        etag

string

[Output-only] A hash of the resource.


                        friendlyName

string

[Optional] A descriptive name for the dataset.

id

string

[Output-only] The fully-qualified unique name of the 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.


                        kind

string
Default value: bigquery#dataset

[Output-only] The resource type.


                        labels

object

The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information.


                        lastModifiedTime

string

[Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.


                        location

string

The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.


                        selfLink

string

[Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.

PUT

/projects/{projectId}/datasets/{datasetId}

Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource.

Request

Path

Name	Data Type	Description
`projectId`	string	Project ID of the dataset being updated
`datasetId`	string	Dataset ID of the dataset being updated

Body

Name Data Type Description

Dataset

Dataset object

Properties


                        access

array [object]

[Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;


                        creationTime

string

[Output-only] The time when this dataset was created, in milliseconds since the epoch.


                        datasetReference

DatasetReference

[Required] A reference that identifies the dataset.

DatasetReference object

Properties

`datasetId`	string	[Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
`projectId`	string	[Optional] The ID of the project containing this dataset.

defaultEncryptionConfiguration EncryptionConfiguration

EncryptionConfiguration object

Properties


                        kmsKeyName

string

[Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.


                        defaultPartitionExpirationMs

string

[Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property.


                        defaultTableExpirationMs

string

[Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.


                        description

string

[Optional] A user-friendly description of the dataset.


                        etag

string

[Output-only] A hash of the resource.


                        friendlyName

string

[Optional] A descriptive name for the dataset.

id

string

[Output-only] The fully-qualified unique name of the 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.


                        kind

string
Default value: bigquery#dataset

[Output-only] The resource type.


                        labels

object

The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information.


                        lastModifiedTime

string

[Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.


                        location

string

The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.


                        selfLink

string

[Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.

Responses

200Successful response

Body

Name Data Type Description

Dataset

Dataset object

Properties


                        access

array [object]

[Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;


                        creationTime

string

[Output-only] The time when this dataset was created, in milliseconds since the epoch.


                        datasetReference

DatasetReference

[Required] A reference that identifies the dataset.

DatasetReference object

Properties

`datasetId`	string	[Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
`projectId`	string	[Optional] The ID of the project containing this dataset.

defaultEncryptionConfiguration EncryptionConfiguration

EncryptionConfiguration object

Properties


                        kmsKeyName

string

[Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.


                        defaultPartitionExpirationMs

string

[Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property.


                        defaultTableExpirationMs

string

[Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.


                        description

string

[Optional] A user-friendly description of the dataset.


                        etag

string

[Output-only] A hash of the resource.


                        friendlyName

string

[Optional] A descriptive name for the dataset.

id

string

[Output-only] The fully-qualified unique name of the 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.


                        kind

string
Default value: bigquery#dataset

[Output-only] The resource type.


                        labels

object

The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information.


                        lastModifiedTime

string

[Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.


                        location

string

The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.


                        selfLink

string

[Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.

GET

/projects/{projectId}/datasets

Lists all datasets in the specified project to which you have been granted the READER dataset role.

Request

Path

Name	Data Type	Description
`projectId`	string	Project ID of the datasets to be listed

Query

Name	Data Type	Description
`all`	boolean	Whether to list all datasets, including hidden ones
`filter`	string	An expression for filtering the results of the request by label. The syntax is "labels.[:]". Multiple filters can be ANDed together by connecting with a space. Example: "labels.department:receiving labels.active". See Filtering datasets using labels for details.
`maxResults`	integer	The maximum number of results to return
`pageToken`	string	Page token, returned by a previous call, to request the next page of results

Responses

200Successful response

Body

Name Data Type Description

DatasetList

DatasetList object

Properties

`datasets`	array [object]	An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project.
`etag`	string	A hash value of the results page. You can use this property to determine if the page has changed since the last request.
`kind`	string Default value: `bigquery#datasetList`	The list type. This property always returns the value "bigquery#datasetList".
`nextPageToken`	string	A token that can be used to request the next results page. This property is omitted on the final results page.

POST

/projects/{projectId}/datasets

Creates a new empty dataset.

Request

Path

Name	Data Type	Description
`projectId`	string	Project ID of the new dataset

Body

Name Data Type Description

Dataset

Dataset object

Properties


                        access

array [object]

[Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;


                        creationTime

string

[Output-only] The time when this dataset was created, in milliseconds since the epoch.


                        datasetReference

DatasetReference

[Required] A reference that identifies the dataset.

DatasetReference object

Properties

`datasetId`	string	[Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
`projectId`	string	[Optional] The ID of the project containing this dataset.

defaultEncryptionConfiguration EncryptionConfiguration

EncryptionConfiguration object

Properties


                        kmsKeyName

string

[Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.


                        defaultPartitionExpirationMs

string

[Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property.


                        defaultTableExpirationMs

string

[Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.


                        description

string

[Optional] A user-friendly description of the dataset.


                        etag

string

[Output-only] A hash of the resource.


                        friendlyName

string

[Optional] A descriptive name for the dataset.

id

string

[Output-only] The fully-qualified unique name of the 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.


                        kind

string
Default value: bigquery#dataset

[Output-only] The resource type.


                        labels

object

The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information.


                        lastModifiedTime

string

[Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.


                        location

string

The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.


                        selfLink

string

[Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.

Responses

200Successful response

Body

Name Data Type Description

Dataset

Dataset object

Properties


                        access

array [object]

[Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;


                        creationTime

string

[Output-only] The time when this dataset was created, in milliseconds since the epoch.


                        datasetReference

DatasetReference

[Required] A reference that identifies the dataset.

DatasetReference object

Properties

`datasetId`	string	[Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
`projectId`	string	[Optional] The ID of the project containing this dataset.

defaultEncryptionConfiguration EncryptionConfiguration

EncryptionConfiguration object

Properties


                        kmsKeyName

string

[Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.


                        defaultPartitionExpirationMs

string

[Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property.


                        defaultTableExpirationMs

string

[Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.


                        description

string

[Optional] A user-friendly description of the dataset.


                        etag

string

[Output-only] A hash of the resource.


                        friendlyName

string

[Optional] A descriptive name for the dataset.

id

string

[Output-only] The fully-qualified unique name of the 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.


                        kind

string
Default value: bigquery#dataset

[Output-only] The resource type.


                        labels

object

The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information.


                        lastModifiedTime

string

[Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.


                        location

string

The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.


                        selfLink

string

[Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.

POST

/projects/{projectId}/jobs/{jobId}/cancel

Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs.

Request

Path

Name	Data Type	Description
`projectId`	string	[Required] Project ID of the job to cancel
`jobId`	string	[Required] Job ID of the job to cancel

Query

Name	Data Type	Description
`location`	string	The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

Responses

200Successful response

Body

Name Data Type Description

JobCancelResponse

JobCancelResponse object

Properties

job

Job

The final state of the job.

Job object

Properties

`configuration`	JobConfiguration	[Required] Describes the job configuration.
`etag`	string	[Output-only] A hash of this resource.
`id`	string	[Output-only] Opaque ID field of the job
`jobReference`	JobReference	[Optional] Reference describing the unique-per-user name of the job.
`kind`	string Default value: `bigquery#job`	[Output-only] The type of the resource.
`selfLink`	string	[Output-only] A URL that can be used to access this resource again.
`statistics`	JobStatistics	[Output-only] Information about the job, including starting time and ending time of the job.
`status`	JobStatus	[Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
`user_email`	string	[Output-only] Email address of the user who ran the job.


                        kind

string
Default value: bigquery#jobCancelResponse

The resource type of the response.

GET

/projects/{projectId}/jobs/{jobId}

Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role.

Request

Path

Name	Data Type	Description
`projectId`	string	[Required] Project ID of the requested job
`jobId`	string	[Required] Job ID of the requested job

Query

Name	Data Type	Description
`location`	string	The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

Responses

200Successful response

Body

Name Data Type Description

Job

Job object

Properties


                        configuration

JobConfiguration

[Required] Describes the job configuration.

JobConfiguration object

Properties

`copy`	JobConfigurationTableCopy	[Pick one] Copies a table.
`dryRun`	boolean	[Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
`extract`	JobConfigurationExtract	[Pick one] Configures an extract job.
`jobTimeoutMs`	string	[Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
`jobType`	string	[Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
`labels`	object	The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
`load`	JobConfigurationLoad	[Pick one] Configures a load job.
`query`	JobConfigurationQuery	[Pick one] Configures a query job.


                        etag

string

[Output-only] A hash of this resource.

id

string

[Output-only] Opaque ID field of the job


                        jobReference

JobReference

[Optional] Reference describing the unique-per-user name of the job.

JobReference object

Properties

`jobId`	string	[Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
`location`	string	The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
`projectId`	string	[Required] The ID of the project containing this job.


                        kind

string
Default value: bigquery#job

[Output-only] The type of the resource.


                        selfLink

string

[Output-only] A URL that can be used to access this resource again.


                        statistics

JobStatistics

[Output-only] Information about the job, including starting time and ending time of the job.

JobStatistics object

Properties

`completionRatio`	double	[TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
`creationTime`	string	[Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
`endTime`	string	[Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
`extract`	JobStatistics4	[Output-only] Statistics for an extract job.
`load`	JobStatistics3	[Output-only] Statistics for a load job.
`numChildJobs`	string	[Output-only] Number of child jobs executed.
`parentJobId`	string	[Output-only] If this is a child job, the id of the parent.
`query`	JobStatistics2	[Output-only] Statistics for a query job.
`quotaDeferments`	array []	[Output-only] Quotas which delayed this job's start time.
`reservationUsage`	array []	[Output-only] Job resource usage breakdown by reservation.
`reservation_id`	string	[Output-only] Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.
`scriptStatistics`	ScriptStatistics	[Output-only] Statistics for a child job of a script.
`startTime`	string	[Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
`totalBytesProcessed`	string	[Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
`totalSlotMs`	string	[Output-only] Slot-milliseconds for the job.


                        status

JobStatus

[Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.

JobStatus object

Properties

`errorResult`	ErrorProto	[Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
`errors`	array [ErrorProto]	[Output-only] The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
`state`	string	[Output-only] Running state of the job.


                        user_email

string

[Output-only] Email address of the user who ran the job.

GET

/projects/{projectId}/jobs

Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property.

Request

Path

Name	Data Type	Description
`projectId`	string	Project ID of the jobs to list

Query

Name	Data Type	Description
`allUsers`	boolean	Whether to display jobs owned by all users in the project. Default false
`maxCreationTime`	string	Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned
`maxResults`	integer	Maximum number of results to return
`minCreationTime`	string	Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned
`pageToken`	string	Page token, returned by a previous call, to request the next page of results
`parentJobId`	string	If set, retrieves only jobs whose parent is this job. Otherwise, retrieves only jobs which have no parent
`projection`	string Allowed values: - `full` - `minimal`	Restrict information returned to a set of selected fields
`stateFilter`	array	Filter for job state

Responses

200Successful response

Body

Name Data Type Description

JobList

JobList object

Properties

`etag`	string	A hash of this page of results.
`jobs`	array [object]	List of jobs that were requested.
`kind`	string Default value: `bigquery#jobList`	The resource type of the response.
`nextPageToken`	string	A token to request the next page of results.

POST

/projects/{projectId}/jobs

Starts a new asynchronous job. Requires the Can View project role.

Request

Path

Name	Data Type	Description
`projectId`	string	Project ID of the project that will be billed for the job

Body

Name Data Type Description

Job

Job object

Properties


                        configuration

JobConfiguration

[Required] Describes the job configuration.

JobConfiguration object

Properties

`copy`	JobConfigurationTableCopy	[Pick one] Copies a table.
`dryRun`	boolean	[Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
`extract`	JobConfigurationExtract	[Pick one] Configures an extract job.
`jobTimeoutMs`	string	[Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
`jobType`	string	[Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
`labels`	object	The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
`load`	JobConfigurationLoad	[Pick one] Configures a load job.
`query`	JobConfigurationQuery	[Pick one] Configures a query job.


                        etag

string

[Output-only] A hash of this resource.

id

string

[Output-only] Opaque ID field of the job


                        jobReference

JobReference

[Optional] Reference describing the unique-per-user name of the job.

JobReference object

Properties

`jobId`	string	[Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
`location`	string	The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
`projectId`	string	[Required] The ID of the project containing this job.


                        kind

string
Default value: bigquery#job

[Output-only] The type of the resource.


                        selfLink

string

[Output-only] A URL that can be used to access this resource again.


                        statistics

JobStatistics

[Output-only] Information about the job, including starting time and ending time of the job.

JobStatistics object

Properties

`completionRatio`	double	[TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
`creationTime`	string	[Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
`endTime`	string	[Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
`extract`	JobStatistics4	[Output-only] Statistics for an extract job.
`load`	JobStatistics3	[Output-only] Statistics for a load job.
`numChildJobs`	string	[Output-only] Number of child jobs executed.
`parentJobId`	string	[Output-only] If this is a child job, the id of the parent.
`query`	JobStatistics2	[Output-only] Statistics for a query job.
`quotaDeferments`	array []	[Output-only] Quotas which delayed this job's start time.
`reservationUsage`	array []	[Output-only] Job resource usage breakdown by reservation.
`reservation_id`	string	[Output-only] Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.
`scriptStatistics`	ScriptStatistics	[Output-only] Statistics for a child job of a script.
`startTime`	string	[Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
`totalBytesProcessed`	string	[Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
`totalSlotMs`	string	[Output-only] Slot-milliseconds for the job.


                        status

JobStatus

[Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.

JobStatus object

Properties

`errorResult`	ErrorProto	[Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
`errors`	array [ErrorProto]	[Output-only] The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
`state`	string	[Output-only] Running state of the job.


                        user_email

string

[Output-only] Email address of the user who ran the job.

Responses

200Successful response

Body

Name Data Type Description

Job

Job object

Properties


                        configuration

JobConfiguration

[Required] Describes the job configuration.

JobConfiguration object

Properties

`copy`	JobConfigurationTableCopy	[Pick one] Copies a table.
`dryRun`	boolean	[Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
`extract`	JobConfigurationExtract	[Pick one] Configures an extract job.
`jobTimeoutMs`	string	[Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
`jobType`	string	[Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
`labels`	object	The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
`load`	JobConfigurationLoad	[Pick one] Configures a load job.
`query`	JobConfigurationQuery	[Pick one] Configures a query job.


                        etag

string

[Output-only] A hash of this resource.

id

string

[Output-only] Opaque ID field of the job


                        jobReference

JobReference

[Optional] Reference describing the unique-per-user name of the job.

JobReference object

Properties

`jobId`	string	[Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
`location`	string	The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
`projectId`	string	[Required] The ID of the project containing this job.


                        kind

string
Default value: bigquery#job

[Output-only] The type of the resource.


                        selfLink

string

[Output-only] A URL that can be used to access this resource again.


                        statistics

JobStatistics

[Output-only] Information about the job, including starting time and ending time of the job.

JobStatistics object

Properties

`completionRatio`	double	[TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
`creationTime`	string	[Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
`endTime`	string	[Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
`extract`	JobStatistics4	[Output-only] Statistics for an extract job.
`load`	JobStatistics3	[Output-only] Statistics for a load job.
`numChildJobs`	string	[Output-only] Number of child jobs executed.
`parentJobId`	string	[Output-only] If this is a child job, the id of the parent.
`query`	JobStatistics2	[Output-only] Statistics for a query job.
`quotaDeferments`	array []	[Output-only] Quotas which delayed this job's start time.
`reservationUsage`	array []	[Output-only] Job resource usage breakdown by reservation.
`reservation_id`	string	[Output-only] Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.
`scriptStatistics`	ScriptStatistics	[Output-only] Statistics for a child job of a script.
`startTime`	string	[Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
`totalBytesProcessed`	string	[Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
`totalSlotMs`	string	[Output-only] Slot-milliseconds for the job.


                        status

JobStatus

[Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.

JobStatus object

Properties

`errorResult`	ErrorProto	[Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
`errors`	array [ErrorProto]	[Output-only] The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
`state`	string	[Output-only] Running state of the job.


                        user_email

string

[Output-only] Email address of the user who ran the job.

GET

/projects/{projectId}/queries/{jobId}

Retrieves the results of a query job.

Request

Path

Name	Data Type	Description
`projectId`	string	[Required] Project ID of the query job
`jobId`	string	[Required] Job ID of the query job

Query

Name	Data Type	Description
`location`	string	The geographic location where the job should run. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
`maxResults`	integer	Maximum number of results to read
`pageToken`	string	Page token, returned by a previous call, to request the next page of results
`startIndex`	string	Zero-based index of the starting row
`timeoutMs`	integer	How long to wait for the query to complete, in milliseconds, before returning. Default is 10 seconds. If the timeout passes before the job completes, the 'jobComplete' field in the response will be false

Responses

200Successful response

Body

Name Data Type Description

GetQueryResultsResponse

GetQueryResultsResponse object

Properties


                        cacheHit

boolean

Whether the query result was fetched from the query cache.


                        errors

array [ErrorProto]

[Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.

ErrorProto object

Properties

`debugInfo`	string	Debugging information. This property is internal to Google and should not be used.
`location`	string	Specifies where the error occurred, if present.
`message`	string	A human-readable description of the error.
`reason`	string	A short error code that summarizes the error.


                        etag

string

A hash of this response.


                        jobComplete

boolean

Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.


                        jobReference

JobReference

Reference to the BigQuery Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).

JobReference object

Properties

`jobId`	string	[Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
`location`	string	The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
`projectId`	string	[Required] The ID of the project containing this job.


                        kind

string
Default value: bigquery#getQueryResultsResponse

The resource type of the response.


                        numDmlAffectedRows

string

[Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.


                        pageToken

string

A token used for paging results.


                        rows

array [TableRow]

An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Present only when the query completes successfully.

TableRow object

Properties

array [TableCell]

Represents a single row in the result set, consisting of one or more fields.


                        schema

TableSchema

The schema of the results. Present only when the query completes successfully.

TableSchema object

Properties


                        fields

array [TableFieldSchema]

Describes the fields in a table.


                        totalBytesProcessed

string

The total number of bytes processed for this query.


                        totalRows

string

The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. Present only when the query completes successfully.

POST

/projects/{projectId}/queries

Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.

Request

Path

Name	Data Type	Description
`projectId`	string	Project ID of the project billed for the query

Body

Name Data Type Description

QueryRequest

QueryRequest object

Properties


                        defaultDataset

DatasetReference

[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 qualified in the format 'datasetId.tableId'.

DatasetReference object

Properties

`datasetId`	string	[Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
`projectId`	string	[Optional] The ID of the project containing this dataset.


                        dryRun

boolean

[Optional] If set to true, BigQuery doesn't run the job. Instead, if the query is valid, BigQuery returns statistics about the job such as how many bytes would be processed. If the query is invalid, an error returns. The default value is false.


                        kind

string
Default value: bigquery#queryRequest

The resource type of the request.


                        location

string

The geographic location where the job should run. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.


                        maxResults

integer

[Optional] The maximum number of rows of data to return per page of results. Setting this flag to a small value such as 1000 and then paging through results might improve reliability when the query result set is large. In addition to this limit, responses are also limited to 10 MB. By default, there is no maximum row count, and only the byte limit applies.


                        parameterMode

string

Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.


                        preserveNulls

boolean

[Deprecated] This property is deprecated.


                        query

string

[Required] A query string, following the BigQuery query syntax, of the query to execute. Example: "SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]".


                        queryParameters

array [QueryParameter]

Query parameters for Standard SQL queries.

QueryParameter object

Properties

`name`	string	[Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
`parameterType`	QueryParameterType	[Required] The type of this parameter.
`parameterValue`	QueryParameterValue	[Required] The value of this parameter.


                        timeoutMs

integer

[Optional] How long to wait for the query to complete, in milliseconds, before the request times out and returns. Note that this is only a timeout for the request, not the query. If the query takes longer to run than the timeout value, the call returns without any results and with the 'jobComplete' flag set to false. You can call GetQueryResults() to wait for the query to complete and read the results. The default value is 10000 milliseconds (10 seconds).


                        useLegacySql

boolean
Default value: true

Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.


                        useQueryCache

boolean
Default value: true

[Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true.

Responses

200Successful response

Body

Name Data Type Description

QueryResponse

QueryResponse object

Properties


                        cacheHit

boolean

Whether the query result was fetched from the query cache.


                        errors

array [ErrorProto]

[Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.

ErrorProto object

Properties

`debugInfo`	string	Debugging information. This property is internal to Google and should not be used.
`location`	string	Specifies where the error occurred, if present.
`message`	string	A human-readable description of the error.
`reason`	string	A short error code that summarizes the error.


                        jobComplete

boolean

Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.


                        jobReference

JobReference

Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).

JobReference object

Properties

`jobId`	string	[Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
`location`	string	The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
`projectId`	string	[Required] The ID of the project containing this job.


                        kind

string
Default value: bigquery#queryResponse

The resource type.


                        numDmlAffectedRows

string

[Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.


                        pageToken

string

A token used for paging results.


                        rows

array [TableRow]

An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above.

TableRow object

Properties

array [TableCell]

Represents a single row in the result set, consisting of one or more fields.


                        schema

TableSchema

The schema of the results. Present only when the query completes successfully.

TableSchema object

Properties


                        fields

array [TableFieldSchema]

Describes the fields in a table.


                        totalBytesProcessed

string

The total number of bytes processed for this query. If this query was a dry run, this is the number of bytes that would be processed if the query were run.


                        totalRows

string

The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results.

DELETE

/projects/{projectId}/datasets/{datasetId}/models/{modelId}

Deletes the model specified by modelId from the dataset.

Request

Path

Name	Data Type	Description
`projectId`	string	Required. Project ID of the model to delete.
`datasetId`	string	Required. Dataset ID of the model to delete.
`modelId`	string	Required. Model ID of the model to delete.

Responses

200Successful response

GET

/projects/{projectId}/datasets/{datasetId}/models/{modelId}

Gets the specified model resource by model ID.

Request

Path

Name	Data Type	Description
`projectId`	string	Required. Project ID of the requested model.
`datasetId`	string	Required. Dataset ID of the requested model.
`modelId`	string	Required. Model ID of the requested model.

Responses

200Successful response

Body

Name Data Type Description

Model

Model object

Properties


                        creationTime

string

Output only. The time when this model was created, in millisecs since the epoch.


                        description

string

Optional. A user-friendly description of this model.


                        encryptionConfiguration

EncryptionConfiguration

Custom encryption configuration (e.g., Cloud KMS keys). This shows the encryption configuration of the model data while stored in BigQuery storage. This field can be used with PatchModel to update encryption key for an already encrypted model.

EncryptionConfiguration object

Properties


                        kmsKeyName

string

[Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.


                        etag

string

Output only. A hash of this resource.


                        expirationTime

string

Optional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models.


                        featureColumns

array [StandardSqlField]

Output only. Input feature columns that were used to train this model.


                        StandardSqlField

object

A field or a column.

Properties

`name`	string	Optional. The name of this field. Can be absent for struct fields.
`type`	StandardSqlDataType	Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).


                        friendlyName

string

Optional. A descriptive name for this model.


                        labelColumns

array [StandardSqlField]

Output only. Label columns that were used to train this model. The output of the model will have a "predicted_" prefix to these columns.


                        StandardSqlField

object

A field or a column.

Properties

`name`	string	Optional. The name of this field. Can be absent for struct fields.
`type`	StandardSqlDataType	Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).


                        labels

object

The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.


                        lastModifiedTime

string

Output only. The time when this model was last modified, in millisecs since the epoch.


                        location

string

Output only. The geographic location where the model resides. This value is inherited from the dataset.


                        modelReference

ModelReference

Required. Unique identifier for this model.

ModelReference object

Properties

`datasetId`	string	[Required] The ID of the dataset containing this model.
`modelId`	string	[Required] The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
`projectId`	string	[Required] The ID of the project containing this model.


                        modelType

string
Allowed values:
- MODEL_TYPE_UNSPECIFIED
- LINEAR_REGRESSION
- LOGISTIC_REGRESSION
- KMEANS
- TENSORFLOW

Output only. Type of the model resource.


                        trainingRuns

array [TrainingRun]

Output only. Information for all training runs in increasing order of start_time.


                        TrainingRun

object

Information about a single training query run for the model.

Properties

`dataSplitResult`	DataSplitResult	Data split result of the training run. Only set when the input data is actually split.
`evaluationMetrics`	EvaluationMetrics	The evaluation metrics over training/eval data that were computed at the end of training.
`results`	array [IterationResult]	Output of each iteration run, results.size() <= max_iterations.
`startTime`	string	The start time of this training run.
`trainingOptions`	TrainingOptions	Options that were used for this training run, includes user specified and default options that were used.

PATCH

/projects/{projectId}/datasets/{datasetId}/models/{modelId}

Patch specific fields in the specified model.

Request

Path

Name	Data Type	Description
`projectId`	string	Required. Project ID of the model to patch.
`datasetId`	string	Required. Dataset ID of the model to patch.
`modelId`	string	Required. Model ID of the model to patch.

Body

Name Data Type Description

Model

Model object

Properties


                        creationTime

string

Output only. The time when this model was created, in millisecs since the epoch.


                        description

string

Optional. A user-friendly description of this model.


                        encryptionConfiguration

EncryptionConfiguration

Custom encryption configuration (e.g., Cloud KMS keys). This shows the encryption configuration of the model data while stored in BigQuery storage. This field can be used with PatchModel to update encryption key for an already encrypted model.

EncryptionConfiguration object

Properties


                        kmsKeyName

string

[Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.


                        etag

string

Output only. A hash of this resource.


                        expirationTime

string

Optional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models.


                        featureColumns

array [StandardSqlField]

Output only. Input feature columns that were used to train this model.


                        StandardSqlField

object

A field or a column.

Properties

`name`	string	Optional. The name of this field. Can be absent for struct fields.
`type`	StandardSqlDataType	Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).


                        friendlyName

string

Optional. A descriptive name for this model.


                        labelColumns

array [StandardSqlField]

Output only. Label columns that were used to train this model. The output of the model will have a "predicted_" prefix to these columns.


                        StandardSqlField

object

A field or a column.

Properties

`name`	string	Optional. The name of this field. Can be absent for struct fields.
`type`	StandardSqlDataType	Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).


                        labels

object

The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.


                        lastModifiedTime

string

Output only. The time when this model was last modified, in millisecs since the epoch.


                        location

string

Output only. The geographic location where the model resides. This value is inherited from the dataset.


                        modelReference

ModelReference

Required. Unique identifier for this model.

ModelReference object

Properties

`datasetId`	string	[Required] The ID of the dataset containing this model.
`modelId`	string	[Required] The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
`projectId`	string	[Required] The ID of the project containing this model.


                        modelType

string
Allowed values:
- MODEL_TYPE_UNSPECIFIED
- LINEAR_REGRESSION
- LOGISTIC_REGRESSION
- KMEANS
- TENSORFLOW

Output only. Type of the model resource.


                        trainingRuns

array [TrainingRun]

Output only. Information for all training runs in increasing order of start_time.


                        TrainingRun

object

Information about a single training query run for the model.

Properties

`dataSplitResult`	DataSplitResult	Data split result of the training run. Only set when the input data is actually split.
`evaluationMetrics`	EvaluationMetrics	The evaluation metrics over training/eval data that were computed at the end of training.
`results`	array [IterationResult]	Output of each iteration run, results.size() <= max_iterations.
`startTime`	string	The start time of this training run.
`trainingOptions`	TrainingOptions	Options that were used for this training run, includes user specified and default options that were used.

Responses

200Successful response

Body

Name Data Type Description

Model

Model object

Properties


                        creationTime

string

Output only. The time when this model was created, in millisecs since the epoch.


                        description

string

Optional. A user-friendly description of this model.


                        encryptionConfiguration

EncryptionConfiguration

Custom encryption configuration (e.g., Cloud KMS keys). This shows the encryption configuration of the model data while stored in BigQuery storage. This field can be used with PatchModel to update encryption key for an already encrypted model.

EncryptionConfiguration object

Properties


                        kmsKeyName

string

[Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.


                        etag

string

Output only. A hash of this resource.


                        expirationTime

string

Optional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models.


                        featureColumns

array [StandardSqlField]

Output only. Input feature columns that were used to train this model.


                        StandardSqlField

object

A field or a column.

Properties

`name`	string	Optional. The name of this field. Can be absent for struct fields.
`type`	StandardSqlDataType	Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).


                        friendlyName

string

Optional. A descriptive name for this model.


                        labelColumns

array [StandardSqlField]

Output only. Label columns that were used to train this model. The output of the model will have a "predicted_" prefix to these columns.


                        StandardSqlField

object

A field or a column.

Properties

`name`	string	Optional. The name of this field. Can be absent for struct fields.
`type`	StandardSqlDataType	Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).


                        labels

object

The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.


                        lastModifiedTime

string

Output only. The time when this model was last modified, in millisecs since the epoch.


                        location

string

Output only. The geographic location where the model resides. This value is inherited from the dataset.


                        modelReference

ModelReference

Required. Unique identifier for this model.

ModelReference object

Properties

`datasetId`	string	[Required] The ID of the dataset containing this model.
`modelId`	string	[Required] The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
`projectId`	string	[Required] The ID of the project containing this model.


                        modelType

string
Allowed values:
- MODEL_TYPE_UNSPECIFIED
- LINEAR_REGRESSION
- LOGISTIC_REGRESSION
- KMEANS
- TENSORFLOW

Output only. Type of the model resource.


                        trainingRuns

array [TrainingRun]

Output only. Information for all training runs in increasing order of start_time.


                        TrainingRun

object

Information about a single training query run for the model.

Properties

`dataSplitResult`	DataSplitResult	Data split result of the training run. Only set when the input data is actually split.
`evaluationMetrics`	EvaluationMetrics	The evaluation metrics over training/eval data that were computed at the end of training.
`results`	array [IterationResult]	Output of each iteration run, results.size() <= max_iterations.
`startTime`	string	The start time of this training run.
`trainingOptions`	TrainingOptions	Options that were used for this training run, includes user specified and default options that were used.

GET

/projects/{projectId}/datasets/{datasetId}/models

Lists all models in the specified dataset. Requires the READER dataset role.

Request

Path

Name	Data Type	Description
`projectId`	string	Required. Project ID of the models to list.
`datasetId`	string	Required. Dataset ID of the models to list.

Query

Name	Data Type	Description
`maxResults`	integer	The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
`pageToken`	string	Page token, returned by a previous call to request the next page of results

Responses

200Successful response

Body

Name Data Type Description

ListModelsResponse

ListModelsResponse object

Properties


                        models

array [Model]

Models in the requested dataset. Only the following fields are populated: model_reference, model_type, creation_time, last_modified_time and labels.

Model object

Properties

`creationTime`	string	Output only. The time when this model was created, in millisecs since the epoch.
`description`	string	Optional. A user-friendly description of this model.
`encryptionConfiguration`	EncryptionConfiguration	Custom encryption configuration (e.g., Cloud KMS keys). This shows the encryption configuration of the model data while stored in BigQuery storage. This field can be used with PatchModel to update encryption key for an already encrypted model.
`etag`	string	Output only. A hash of this resource.
`expirationTime`	string	Optional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models.
`featureColumns`	array [StandardSqlField]	Output only. Input feature columns that were used to train this model.
`friendlyName`	string	Optional. A descriptive name for this model.
`labelColumns`	array [StandardSqlField]	Output only. Label columns that were used to train this model. The output of the model will have a "predicted_" prefix to these columns.
`labels`	object	The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
`lastModifiedTime`	string	Output only. The time when this model was last modified, in millisecs since the epoch.
`location`	string	Output only. The geographic location where the model resides. This value is inherited from the dataset.
`modelReference`	ModelReference	Required. Unique identifier for this model.
`modelType`	string Allowed values: - `MODEL_TYPE_UNSPECIFIED` - `LINEAR_REGRESSION` - `LOGISTIC_REGRESSION` - `KMEANS` - `TENSORFLOW`	Output only. Type of the model resource.
`trainingRuns`	array [TrainingRun]	Output only. Information for all training runs in increasing order of start_time.


                        nextPageToken

string

A token to request the next page of results.

GET

/projects/{projectId}/serviceAccount

Returns the email address of the service account for your project used for interactions with Google Cloud KMS.

Request

Path

Name	Data Type	Description
`projectId`	string	Project ID for which the service account is requested.

Responses

200Successful response

Body

Name Data Type Description

GetServiceAccountResponse

GetServiceAccountResponse object

Properties

`email`	string	The service account email address.
`kind`	string Default value: `bigquery#getServiceAccountResponse`	The resource type of the response.

GET

/projects

Lists all projects to which you have been granted any project role.

Request

Query

Name	Data Type	Description
`maxResults`	integer	Maximum number of results to return
`pageToken`	string	Page token, returned by a previous call, to request the next page of results

Responses

200Successful response

Body

Name Data Type Description

ProjectList

ProjectList object

Properties

`etag`	string	A hash of the page of results
`kind`	string Default value: `bigquery#projectList`	The type of list.
`nextPageToken`	string	A token to request the next page of results.
`projects`	array [object]	Projects to which you have at least READ access.
`totalItems`	integer	The total number of projects in the list.

DELETE

/projects/{projectId}/datasets/{datasetId}/routines/{routineId}

Deletes the routine specified by routineId from the dataset.

Request

Path

Name	Data Type	Description
`projectId`	string	Required. Project ID of the routine to delete
`datasetId`	string	Required. Dataset ID of the routine to delete
`routineId`	string	Required. Routine ID of the routine to delete

Responses

200Successful response

GET

/projects/{projectId}/datasets/{datasetId}/routines/{routineId}

Gets the specified routine resource by routine ID.

Request

Path

Name	Data Type	Description
`projectId`	string	Required. Project ID of the requested routine
`datasetId`	string	Required. Dataset ID of the requested routine
`routineId`	string	Required. Routine ID of the requested routine

Query

Name	Data Type	Description
`readMask`	string	If set, only the Routine fields in the field mask are returned in the response. If unset, all Routine fields are returned.

Responses

200Successful response

Body

Name Data Type Description

Routine


                        Routine

object

A user-defined function or a stored procedure.

Properties


                        arguments

array [Argument]

Optional.


                        Argument

object

Input/output argument of a function or a stored procedure.

Properties

`argumentKind`	string Allowed values: - `ARGUMENT_KIND_UNSPECIFIED` - `FIXED_TYPE` - `ANY_TYPE`	Optional. Defaults to FIXED_TYPE.
`dataType`	StandardSqlDataType	Required unless argument_kind = ANY_TYPE.
`mode`	string Allowed values: - `MODE_UNSPECIFIED` - `IN` - `OUT` - `INOUT`	Optional. Specifies whether the argument is input or output. Can be set for procedures only.
`name`	string	Optional. The name of this argument. Can be absent for function return argument.


                        creationTime

string

Output only. The time when this routine was created, in milliseconds since the epoch.


                        definitionBody

string

Required. The body of the routine.

For functions, this is the expression in the AS clause.

If language=SQL, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement:

CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y))

The definition_body is concat(x, "\n", y) (\n is not replaced with linebreak).

If language=JAVASCRIPT, it is the evaluated string in the AS clause. For example, for the function created with the following statement:

CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n'

The definition_body is

return "\n";\n

Note that both \n are replaced with linebreaks.


                        description

string

Optional. [Experimental] The description of the routine if defined.


                        etag

string

Output only. A hash of this resource.


                        importedLibraries

array [string]

Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries.


                        language

string
Allowed values:
- LANGUAGE_UNSPECIFIED
- SQL
- JAVASCRIPT

Optional. Defaults to "SQL".


                        lastModifiedTime

string

Output only. The time when this routine was last modified, in milliseconds since the epoch.


                        returnType

StandardSqlDataType

Optional if language = "SQL"; required otherwise.

If absent, the return type is inferred from definition_body at query time in each query that references this routine. If present, then the evaluated result will be cast to the specified returned type at query time.

For example, for the functions created with the following statements:

CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y);
CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1));
CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));

The return_type is {type_kind: "FLOAT64"} for Add and Decrement, and is absent for Increment (inferred as FLOAT64 at query time).

Suppose the function Add is replaced by CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y);

Then the inferred return type of Increment is automatically changed to INT64 at query time, while the return type of Decrement remains FLOAT64.


                        StandardSqlDataType

object

The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT<x STRING, y ARRAY>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}}

Properties

`arrayElementType`	StandardSqlDataType	The type of the array's elements, if type_kind = "ARRAY".
`structType`	StandardSqlStructType	The fields of this struct, in order, if type_kind = "STRUCT".
`typeKind`	string Allowed values: - `TYPE_KIND_UNSPECIFIED` - `INT64` - `BOOL` - `FLOAT64` - `STRING` - `BYTES` - `TIMESTAMP` - `DATE` - `TIME` - `DATETIME` - `GEOGRAPHY` - `NUMERIC` - `ARRAY` - `STRUCT`	Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").


                        routineReference

RoutineReference

Required. Reference describing the ID of this routine.

RoutineReference object

Properties

`datasetId`	string	[Required] The ID of the dataset containing this routine.
`projectId`	string	[Required] The ID of the project containing this routine.
`routineId`	string	[Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.


                        routineType

string
Allowed values:
- ROUTINE_TYPE_UNSPECIFIED
- SCALAR_FUNCTION
- PROCEDURE

Required. The type of routine.

PUT

/projects/{projectId}/datasets/{datasetId}/routines/{routineId}

Updates information in an existing routine. The update method replaces the entire Routine resource.

Request

Path

Name	Data Type	Description
`projectId`	string	Required. Project ID of the routine to update
`datasetId`	string	Required. Dataset ID of the routine to update
`routineId`	string	Required. Routine ID of the routine to update

Body

Name Data Type Description

Routine


                        Routine

object

A user-defined function or a stored procedure.

Properties


                        arguments

array [Argument]

Optional.


                        Argument

object

Input/output argument of a function or a stored procedure.

Properties

`argumentKind`	string Allowed values: - `ARGUMENT_KIND_UNSPECIFIED` - `FIXED_TYPE` - `ANY_TYPE`	Optional. Defaults to FIXED_TYPE.
`dataType`	StandardSqlDataType	Required unless argument_kind = ANY_TYPE.
`mode`	string Allowed values: - `MODE_UNSPECIFIED` - `IN` - `OUT` - `INOUT`	Optional. Specifies whether the argument is input or output. Can be set for procedures only.
`name`	string	Optional. The name of this argument. Can be absent for function return argument.


                        creationTime

string

Output only. The time when this routine was created, in milliseconds since the epoch.


                        definitionBody

string

Required. The body of the routine.

For functions, this is the expression in the AS clause.

If language=SQL, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement:

CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y))

The definition_body is concat(x, "\n", y) (\n is not replaced with linebreak).

If language=JAVASCRIPT, it is the evaluated string in the AS clause. For example, for the function created with the following statement:

CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n'

The definition_body is

return "\n";\n

Note that both \n are replaced with linebreaks.


                        description

string

Optional. [Experimental] The description of the routine if defined.


                        etag

string

Output only. A hash of this resource.


                        importedLibraries

array [string]

Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries.


                        language

string
Allowed values:
- LANGUAGE_UNSPECIFIED
- SQL
- JAVASCRIPT

Optional. Defaults to "SQL".


                        lastModifiedTime

string

Output only. The time when this routine was last modified, in milliseconds since the epoch.


                        returnType

StandardSqlDataType

Optional if language = "SQL"; required otherwise.

If absent, the return type is inferred from definition_body at query time in each query that references this routine. If present, then the evaluated result will be cast to the specified returned type at query time.

For example, for the functions created with the following statements:

CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y);
CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1));
CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));

The return_type is {type_kind: "FLOAT64"} for Add and Decrement, and is absent for Increment (inferred as FLOAT64 at query time).

Suppose the function Add is replaced by CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y);

Then the inferred return type of Increment is automatically changed to INT64 at query time, while the return type of Decrement remains FLOAT64.


                        StandardSqlDataType

object

The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT<x STRING, y ARRAY>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}}

Properties

`arrayElementType`	StandardSqlDataType	The type of the array's elements, if type_kind = "ARRAY".
`structType`	StandardSqlStructType	The fields of this struct, in order, if type_kind = "STRUCT".
`typeKind`	string Allowed values: - `TYPE_KIND_UNSPECIFIED` - `INT64` - `BOOL` - `FLOAT64` - `STRING` - `BYTES` - `TIMESTAMP` - `DATE` - `TIME` - `DATETIME` - `GEOGRAPHY` - `NUMERIC` - `ARRAY` - `STRUCT`	Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").


                        routineReference

RoutineReference

Required. Reference describing the ID of this routine.

RoutineReference object

Properties

`datasetId`	string	[Required] The ID of the dataset containing this routine.
`projectId`	string	[Required] The ID of the project containing this routine.
`routineId`	string	[Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.


                        routineType

string
Allowed values:
- ROUTINE_TYPE_UNSPECIFIED
- SCALAR_FUNCTION
- PROCEDURE

Required. The type of routine.

Responses

200Successful response

Body

Name Data Type Description

Routine


                        Routine

object

A user-defined function or a stored procedure.

Properties


                        arguments

array [Argument]

Optional.


                        Argument

object

Input/output argument of a function or a stored procedure.

Properties

`argumentKind`	string Allowed values: - `ARGUMENT_KIND_UNSPECIFIED` - `FIXED_TYPE` - `ANY_TYPE`	Optional. Defaults to FIXED_TYPE.
`dataType`	StandardSqlDataType	Required unless argument_kind = ANY_TYPE.
`mode`	string Allowed values: - `MODE_UNSPECIFIED` - `IN` - `OUT` - `INOUT`	Optional. Specifies whether the argument is input or output. Can be set for procedures only.
`name`	string	Optional. The name of this argument. Can be absent for function return argument.


                        creationTime

string

Output only. The time when this routine was created, in milliseconds since the epoch.


                        definitionBody

string

Required. The body of the routine.

For functions, this is the expression in the AS clause.

If language=SQL, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement:

CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y))

The definition_body is concat(x, "\n", y) (\n is not replaced with linebreak).

If language=JAVASCRIPT, it is the evaluated string in the AS clause. For example, for the function created with the following statement:

CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n'

The definition_body is

return "\n";\n

Note that both \n are replaced with linebreaks.


                        description

string

Optional. [Experimental] The description of the routine if defined.


                        etag

string

Output only. A hash of this resource.


                        importedLibraries

array [string]

Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries.


                        language

string
Allowed values:
- LANGUAGE_UNSPECIFIED
- SQL
- JAVASCRIPT

Optional. Defaults to "SQL".


                        lastModifiedTime

string

Output only. The time when this routine was last modified, in milliseconds since the epoch.


                        returnType

StandardSqlDataType

Optional if language = "SQL"; required otherwise.

If absent, the return type is inferred from definition_body at query time in each query that references this routine. If present, then the evaluated result will be cast to the specified returned type at query time.

For example, for the functions created with the following statements:

CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y);
CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1));
CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));

The return_type is {type_kind: "FLOAT64"} for Add and Decrement, and is absent for Increment (inferred as FLOAT64 at query time).

Suppose the function Add is replaced by CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y);

Then the inferred return type of Increment is automatically changed to INT64 at query time, while the return type of Decrement remains FLOAT64.


                        StandardSqlDataType

object

The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT<x STRING, y ARRAY>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}}

Properties

`arrayElementType`	StandardSqlDataType	The type of the array's elements, if type_kind = "ARRAY".
`structType`	StandardSqlStructType	The fields of this struct, in order, if type_kind = "STRUCT".
`typeKind`	string Allowed values: - `TYPE_KIND_UNSPECIFIED` - `INT64` - `BOOL` - `FLOAT64` - `STRING` - `BYTES` - `TIMESTAMP` - `DATE` - `TIME` - `DATETIME` - `GEOGRAPHY` - `NUMERIC` - `ARRAY` - `STRUCT`	Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").


                        routineReference

RoutineReference

Required. Reference describing the ID of this routine.

RoutineReference object

Properties

`datasetId`	string	[Required] The ID of the dataset containing this routine.
`projectId`	string	[Required] The ID of the project containing this routine.
`routineId`	string	[Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.


                        routineType

string
Allowed values:
- ROUTINE_TYPE_UNSPECIFIED
- SCALAR_FUNCTION
- PROCEDURE

Required. The type of routine.

GET

/projects/{projectId}/datasets/{datasetId}/routines

Lists all routines in the specified dataset. Requires the READER dataset role.

Request

Path

Name	Data Type	Description
`projectId`	string	Required. Project ID of the routines to list
`datasetId`	string	Required. Dataset ID of the routines to list

Query

Name	Data Type	Description
`filter`	string	If set, then only the Routines matching this filter are returned. The current supported form is either "routine_type:" or "routineType:", where is a RoutineType enum. Example: "routineType:SCALAR_FUNCTION".
`maxResults`	integer	The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
`pageToken`	string	Page token, returned by a previous call, to request the next page of results
`readMask`	string	If set, then only the Routine fields in the field mask, as well as project_id, dataset_id and routine_id, are returned in the response. If unset, then the following Routine fields are returned: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, and language.

Responses

200Successful response

Body

Name Data Type Description

ListRoutinesResponse

ListRoutinesResponse object

Properties


                        nextPageToken

string

A token to request the next page of results.


                        routines

array [Routine]

Routines in the requested dataset. Unless read_mask is set in the request, only the following fields are populated: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, and language.


                        Routine

object

A user-defined function or a stored procedure.

Properties

`arguments`	array [Argument]	Optional.
`creationTime`	string	Output only. The time when this routine was created, in milliseconds since the epoch.
`definitionBody`	string	Required. The body of the routine. For functions, this is the expression in the AS clause. If language=SQL, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y))` The definition_body is `concat(x, "\n", y)` (\n is not replaced with linebreak). If language=JAVASCRIPT, it is the evaluated string in the AS clause. For example, for the function created with the following statement: `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n'` The definition_body is `return "\n";\n` Note that both \n are replaced with linebreaks.
`description`	string	Optional. [Experimental] The description of the routine if defined.
`etag`	string	Output only. A hash of this resource.
`importedLibraries`	array [string]	Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries.
`language`	string Allowed values: - `LANGUAGE_UNSPECIFIED` - `SQL` - `JAVASCRIPT`	Optional. Defaults to "SQL".
`lastModifiedTime`	string	Output only. The time when this routine was last modified, in milliseconds since the epoch.
`returnType`	StandardSqlDataType	Optional if language = "SQL"; required otherwise. If absent, the return type is inferred from definition_body at query time in each query that references this routine. If present, then the evaluated result will be cast to the specified returned type at query time. For example, for the functions created with the following statements: `CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y);` `CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1));` `CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));` The return_type is `{type_kind: "FLOAT64"}` for `Add` and `Decrement`, and is absent for `Increment` (inferred as FLOAT64 at query time). Suppose the function `Add` is replaced by `CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y);` Then the inferred return type of `Increment` is automatically changed to INT64 at query time, while the return type of `Decrement` remains FLOAT64.
`routineReference`	RoutineReference	Required. Reference describing the ID of this routine.
`routineType`	string Allowed values: - `ROUTINE_TYPE_UNSPECIFIED` - `SCALAR_FUNCTION` - `PROCEDURE`	Required. The type of routine.

POST

/projects/{projectId}/datasets/{datasetId}/routines

Creates a new routine in the dataset.

Request

Path

Name	Data Type	Description
`projectId`	string	Required. Project ID of the new routine
`datasetId`	string	Required. Dataset ID of the new routine

Body

Name Data Type Description

Routine


                        Routine

object

A user-defined function or a stored procedure.

Properties


                        arguments

array [Argument]

Optional.


                        Argument

object

Input/output argument of a function or a stored procedure.

Properties

`argumentKind`	string Allowed values: - `ARGUMENT_KIND_UNSPECIFIED` - `FIXED_TYPE` - `ANY_TYPE`	Optional. Defaults to FIXED_TYPE.
`dataType`	StandardSqlDataType	Required unless argument_kind = ANY_TYPE.
`mode`	string Allowed values: - `MODE_UNSPECIFIED` - `IN` - `OUT` - `INOUT`	Optional. Specifies whether the argument is input or output. Can be set for procedures only.
`name`	string	Optional. The name of this argument. Can be absent for function return argument.


                        creationTime

string

Output only. The time when this routine was created, in milliseconds since the epoch.


                        definitionBody

string

Required. The body of the routine.

For functions, this is the expression in the AS clause.

If language=SQL, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement:

CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y))

The definition_body is concat(x, "\n", y) (\n is not replaced with linebreak).

If language=JAVASCRIPT, it is the evaluated string in the AS clause. For example, for the function created with the following statement:

CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n'

The definition_body is

return "\n";\n

Note that both \n are replaced with linebreaks.


                        description

string

Optional. [Experimental] The description of the routine if defined.


                        etag

string

Output only. A hash of this resource.


                        importedLibraries

array [string]

Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries.


                        language

string
Allowed values:
- LANGUAGE_UNSPECIFIED
- SQL
- JAVASCRIPT

Optional. Defaults to "SQL".


                        lastModifiedTime

string

Output only. The time when this routine was last modified, in milliseconds since the epoch.


                        returnType

StandardSqlDataType

Optional if language = "SQL"; required otherwise.

If absent, the return type is inferred from definition_body at query time in each query that references this routine. If present, then the evaluated result will be cast to the specified returned type at query time.

For example, for the functions created with the following statements:

CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y);
CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1));
CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));

The return_type is {type_kind: "FLOAT64"} for Add and Decrement, and is absent for Increment (inferred as FLOAT64 at query time).

Suppose the function Add is replaced by CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y);

Then the inferred return type of Increment is automatically changed to INT64 at query time, while the return type of Decrement remains FLOAT64.


                        StandardSqlDataType

object

The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT<x STRING, y ARRAY>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}}

Properties

`arrayElementType`	StandardSqlDataType	The type of the array's elements, if type_kind = "ARRAY".
`structType`	StandardSqlStructType	The fields of this struct, in order, if type_kind = "STRUCT".
`typeKind`	string Allowed values: - `TYPE_KIND_UNSPECIFIED` - `INT64` - `BOOL` - `FLOAT64` - `STRING` - `BYTES` - `TIMESTAMP` - `DATE` - `TIME` - `DATETIME` - `GEOGRAPHY` - `NUMERIC` - `ARRAY` - `STRUCT`	Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").


                        routineReference

RoutineReference

Required. Reference describing the ID of this routine.

RoutineReference object

Properties

`datasetId`	string	[Required] The ID of the dataset containing this routine.
`projectId`	string	[Required] The ID of the project containing this routine.
`routineId`	string	[Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.


                        routineType

string
Allowed values:
- ROUTINE_TYPE_UNSPECIFIED
- SCALAR_FUNCTION
- PROCEDURE

Required. The type of routine.

Responses

200Successful response

Body

Name Data Type Description

Routine


                        Routine

object

A user-defined function or a stored procedure.

Properties


                        arguments

array [Argument]

Optional.


                        Argument

object

Input/output argument of a function or a stored procedure.

Properties

`argumentKind`	string Allowed values: - `ARGUMENT_KIND_UNSPECIFIED` - `FIXED_TYPE` - `ANY_TYPE`	Optional. Defaults to FIXED_TYPE.
`dataType`	StandardSqlDataType	Required unless argument_kind = ANY_TYPE.
`mode`	string Allowed values: - `MODE_UNSPECIFIED` - `IN` - `OUT` - `INOUT`	Optional. Specifies whether the argument is input or output. Can be set for procedures only.
`name`	string	Optional. The name of this argument. Can be absent for function return argument.


                        creationTime

string

Output only. The time when this routine was created, in milliseconds since the epoch.


                        definitionBody

string

Required. The body of the routine.

For functions, this is the expression in the AS clause.

If language=SQL, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement:

CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y))

The definition_body is concat(x, "\n", y) (\n is not replaced with linebreak).

If language=JAVASCRIPT, it is the evaluated string in the AS clause. For example, for the function created with the following statement:

CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n'

The definition_body is

return "\n";\n

Note that both \n are replaced with linebreaks.


                        description

string

Optional. [Experimental] The description of the routine if defined.


                        etag

string

Output only. A hash of this resource.


                        importedLibraries

array [string]

Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries.


                        language

string
Allowed values:
- LANGUAGE_UNSPECIFIED
- SQL
- JAVASCRIPT

Optional. Defaults to "SQL".


                        lastModifiedTime

string

Output only. The time when this routine was last modified, in milliseconds since the epoch.


                        returnType

StandardSqlDataType

Optional if language = "SQL"; required otherwise.

If absent, the return type is inferred from definition_body at query time in each query that references this routine. If present, then the evaluated result will be cast to the specified returned type at query time.

For example, for the functions created with the following statements:

CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y);
CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1));
CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));

The return_type is {type_kind: "FLOAT64"} for Add and Decrement, and is absent for Increment (inferred as FLOAT64 at query time).

Suppose the function Add is replaced by CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y);

Then the inferred return type of Increment is automatically changed to INT64 at query time, while the return type of Decrement remains FLOAT64.


                        StandardSqlDataType

object

The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT<x STRING, y ARRAY>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}}

Properties

`arrayElementType`	StandardSqlDataType	The type of the array's elements, if type_kind = "ARRAY".
`structType`	StandardSqlStructType	The fields of this struct, in order, if type_kind = "STRUCT".
`typeKind`	string Allowed values: - `TYPE_KIND_UNSPECIFIED` - `INT64` - `BOOL` - `FLOAT64` - `STRING` - `BYTES` - `TIMESTAMP` - `DATE` - `TIME` - `DATETIME` - `GEOGRAPHY` - `NUMERIC` - `ARRAY` - `STRUCT`	Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").


                        routineReference

RoutineReference

Required. Reference describing the ID of this routine.

RoutineReference object

Properties

`datasetId`	string	[Required] The ID of the dataset containing this routine.
`projectId`	string	[Required] The ID of the project containing this routine.
`routineId`	string	[Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.


                        routineType

string
Allowed values:
- ROUTINE_TYPE_UNSPECIFIED
- SCALAR_FUNCTION
- PROCEDURE

Required. The type of routine.

GET

/projects/{projectId}/datasets/{datasetId}/tables/{tableId}/data

Retrieves table data from a specified set of rows. Requires the READER dataset role.

Request

Path

Name	Data Type	Description
`projectId`	string	Project ID of the table to read
`datasetId`	string	Dataset ID of the table to read
`tableId`	string	Table ID of the table to read

Query

Name	Data Type	Description
`maxResults`	integer	Maximum number of results to return
`pageToken`	string	Page token, returned by a previous call, identifying the result set
`selectedFields`	string	List of fields to return (comma-separated). If unspecified, all fields are returned
`startIndex`	string	Zero-based index of the starting row to read

Responses

200Successful response

Body

Name Data Type Description

TableDataList

TableDataList object

Properties


                        etag

string

A hash of this page of results.


                        kind

string
Default value: bigquery#tableDataList

The resource type of the response.


                        pageToken

string

A token used for paging results. Providing this token instead of the startIndex parameter can help you retrieve stable results when an underlying table is changing.


                        rows

array [TableRow]

Rows of results.

TableRow object

Properties

array [TableCell]

Represents a single row in the result set, consisting of one or more fields.


                        totalRows

string

The total number of rows in the complete table.

POST

/projects/{projectId}/datasets/{datasetId}/tables/{tableId}/insertAll

Streams data into BigQuery one record at a time without needing to run a load job. Requires the WRITER dataset role.

Request

Path

Name	Data Type	Description
`projectId`	string	Project ID of the destination table.
`datasetId`	string	Dataset ID of the destination table.
`tableId`	string	Table ID of the destination table.

Body

Name Data Type Description

TableDataInsertAllRequest

TableDataInsertAllRequest object

Properties

`ignoreUnknownValues`	boolean	[Optional] Accept rows that contain values that do not match the schema. The unknown values are ignored. Default is false, which treats unknown values as errors.
`kind`	string Default value: `bigquery#tableDataInsertAllRequest`	The resource type of the response.
`rows`	array [object]	The rows to insert.
`skipInvalidRows`	boolean	[Optional] Insert all valid rows of a request, even if invalid rows exist. The default value is false, which causes the entire request to fail if any invalid rows exist.
`templateSuffix`	string	If specified, treats the destination table as a base template, and inserts the rows into an instance table named "{destination}{templateSuffix}". BigQuery will manage creation of the instance table, using the schema of the base template table. See https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables for considerations when working with templates tables.

Responses

200Successful response

Body

Name Data Type Description

TableDataInsertAllResponse

TableDataInsertAllResponse object

Properties

`insertErrors`	array [object]	An array of errors for rows that were not inserted.
`kind`	string Default value: `bigquery#tableDataInsertAllResponse`	The resource type of the response.

DELETE

/projects/{projectId}/datasets/{datasetId}/tables/{tableId}

Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.

Request

Path

Name	Data Type	Description
`projectId`	string	Project ID of the table to delete
`datasetId`	string	Dataset ID of the table to delete
`tableId`	string	Table ID of the table to delete

Responses

200Successful response

GET

/projects/{projectId}/datasets/{datasetId}/tables/{tableId}

Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table.

Request

Path

Name	Data Type	Description
`projectId`	string	Project ID of the requested table
`datasetId`	string	Dataset ID of the requested table
`tableId`	string	Table ID of the requested table

Query

Name	Data Type	Description
`selectedFields`	string	List of fields to return (comma-separated). If unspecified, all fields are returned

Responses

200Successful response

Body

Name Data Type Description

Table

Table object

Properties


                        clustering

Clustering

[Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.

Clustering object

Properties


                        fields

array []

[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.


                        creationTime

string

[Output-only] The time when this table was created, in milliseconds since the epoch.


                        description

string

[Optional] A user-friendly description of this table.


                        encryptionConfiguration

EncryptionConfiguration

Custom encryption configuration (e.g., Cloud KMS keys).

EncryptionConfiguration object

Properties


                        kmsKeyName

string

[Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.


                        etag

string

[Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.


                        expirationTime

string

[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. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.


                        externalDataConfiguration

ExternalDataConfiguration

[Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

ExternalDataConfiguration object

Properties

`autodetect`	boolean	Try to detect schema and format options automatically. Any option specified explicitly will be honored.
`bigtableOptions`	BigtableOptions	[Optional] Additional options if sourceFormat is set to BIGTABLE.
`compression`	string	[Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
`csvOptions`	CsvOptions	Additional properties to set if sourceFormat is set to CSV.
`googleSheetsOptions`	GoogleSheetsOptions	[Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
`hivePartitioningMode`	string	[Optional, Trusted Tester] Deprecated, do not use. Please set hivePartitioningOptions instead.
`hivePartitioningOptions`	HivePartitioningOptions	[Optional, Trusted Tester] Options to configure hive partitioning support.
`ignoreUnknownValues`	boolean	[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
`maxBadRecords`	integer	[Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
`schema`	TableSchema	[Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
`sourceFormat`	string	[Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
`sourceUris`	array []	[Required] 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.


                        friendlyName

string

[Optional] A descriptive name for this table.

id

string

[Output-only] An opaque ID uniquely identifying the table.


                        kind

string
Default value: bigquery#table

[Output-only] The type of the resource.


                        labels

object

The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.


                        lastModifiedTime

string

[Output-only] The time when this table was last modified, in milliseconds since the epoch.


                        location

string

[Output-only] The geographic location where the table resides. This value is inherited from the dataset.


                        materializedView

MaterializedViewDefinition

[Optional] Materialized view definition.

MaterializedViewDefinition object

Properties

`enableRefresh`	boolean	[Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".
`lastRefreshTime`	string	[Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.
`query`	string	[Required] A query whose result is persisted.
`refreshIntervalMs`	string	[Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).


                        model

ModelDefinition

[Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries.

ModelDefinition object

Properties

`modelOptions`
`trainingRuns`	array [BqmlTrainingRun]	[Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.


                        numBytes

string

[Output-only] The size of this table in bytes, excluding any data in the streaming buffer.


                        numLongTermBytes

string

[Output-only] The number of bytes in the table that are considered "long-term storage".


                        numPhysicalBytes

string

[Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.


                        numRows

string

[Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.


                        rangePartitioning

RangePartitioning

[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

RangePartitioning object

Properties

`field`	string	[TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
`range`


                        requirePartitionFilter

boolean
Default value: false

[Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.


                        schema

TableSchema

[Optional] Describes the schema of this table.

TableSchema object

Properties


                        fields

array [TableFieldSchema]

Describes the fields in a table.


                        selfLink

string

[Output-only] A URL that can be used to access this resource again.


                        streamingBuffer

Streamingbuffer

[Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

Streamingbuffer object

Properties

`estimatedBytes`	string	[Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.
`estimatedRows`	string	[Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.
`oldestEntryTime`	string	[Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.


                        tableReference

TableReference

[Required] Reference describing the ID of this table.

TableReference object

Properties

`datasetId`	string	[Required] The ID of the dataset containing this table.
`projectId`	string	[Required] The ID of the project containing this table.
`tableId`	string	[Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.


                        timePartitioning

TimePartitioning

Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

TimePartitioning object

Properties

`expirationMs`	string	[Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
`field`	string	[Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
`requirePartitionFilter`	boolean
`type`	string	[Required] The only type supported is DAY, which will generate one partition per day.


                        type

string

[Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.


                        view

ViewDefinition

[Optional] The view definition.

ViewDefinition object

Properties

`query`	string	[Required] A query that BigQuery executes when the view is referenced.
`useLegacySql`	boolean	Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.
`userDefinedFunctionResources`	array [UserDefinedFunctionResource]	Describes user-defined function resources used in the query.

PATCH

/projects/{projectId}/datasets/{datasetId}/tables/{tableId}

Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports patch semantics.

Request

Path

Name	Data Type	Description
`projectId`	string	Project ID of the table to update
`datasetId`	string	Dataset ID of the table to update
`tableId`	string	Table ID of the table to update

Body

Name Data Type Description

Table

Table object

Properties


                        clustering

Clustering

[Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.

Clustering object

Properties


                        fields

array []

[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.


                        creationTime

string

[Output-only] The time when this table was created, in milliseconds since the epoch.


                        description

string

[Optional] A user-friendly description of this table.


                        encryptionConfiguration

EncryptionConfiguration

Custom encryption configuration (e.g., Cloud KMS keys).

EncryptionConfiguration object

Properties


                        kmsKeyName

string

[Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.


                        etag

string

[Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.


                        expirationTime

string

[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. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.


                        externalDataConfiguration

ExternalDataConfiguration

[Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

ExternalDataConfiguration object

Properties

`autodetect`	boolean	Try to detect schema and format options automatically. Any option specified explicitly will be honored.
`bigtableOptions`	BigtableOptions	[Optional] Additional options if sourceFormat is set to BIGTABLE.
`compression`	string	[Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
`csvOptions`	CsvOptions	Additional properties to set if sourceFormat is set to CSV.
`googleSheetsOptions`	GoogleSheetsOptions	[Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
`hivePartitioningMode`	string	[Optional, Trusted Tester] Deprecated, do not use. Please set hivePartitioningOptions instead.
`hivePartitioningOptions`	HivePartitioningOptions	[Optional, Trusted Tester] Options to configure hive partitioning support.
`ignoreUnknownValues`	boolean	[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
`maxBadRecords`	integer	[Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
`schema`	TableSchema	[Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
`sourceFormat`	string	[Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
`sourceUris`	array []	[Required] 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.


                        friendlyName

string

[Optional] A descriptive name for this table.

id

string

[Output-only] An opaque ID uniquely identifying the table.


                        kind

string
Default value: bigquery#table

[Output-only] The type of the resource.


                        labels

object

The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.


                        lastModifiedTime

string

[Output-only] The time when this table was last modified, in milliseconds since the epoch.


                        location

string

[Output-only] The geographic location where the table resides. This value is inherited from the dataset.


                        materializedView

MaterializedViewDefinition

[Optional] Materialized view definition.

MaterializedViewDefinition object

Properties

`enableRefresh`	boolean	[Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".
`lastRefreshTime`	string	[Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.
`query`	string	[Required] A query whose result is persisted.
`refreshIntervalMs`	string	[Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).


                        model

ModelDefinition

[Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries.

ModelDefinition object

Properties

`modelOptions`
`trainingRuns`	array [BqmlTrainingRun]	[Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.


                        numBytes

string

[Output-only] The size of this table in bytes, excluding any data in the streaming buffer.


                        numLongTermBytes

string

[Output-only] The number of bytes in the table that are considered "long-term storage".


                        numPhysicalBytes

string

[Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.


                        numRows

string

[Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.


                        rangePartitioning

RangePartitioning

[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

RangePartitioning object

Properties

`field`	string	[TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
`range`


                        requirePartitionFilter

boolean
Default value: false

[Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.


                        schema

TableSchema

[Optional] Describes the schema of this table.

TableSchema object

Properties


                        fields

array [TableFieldSchema]

Describes the fields in a table.


                        selfLink

string

[Output-only] A URL that can be used to access this resource again.


                        streamingBuffer

Streamingbuffer

[Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

Streamingbuffer object

Properties

`estimatedBytes`	string	[Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.
`estimatedRows`	string	[Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.
`oldestEntryTime`	string	[Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.


                        tableReference

TableReference

[Required] Reference describing the ID of this table.

TableReference object

Properties

`datasetId`	string	[Required] The ID of the dataset containing this table.
`projectId`	string	[Required] The ID of the project containing this table.
`tableId`	string	[Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.


                        timePartitioning

TimePartitioning

Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

TimePartitioning object

Properties

`expirationMs`	string	[Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
`field`	string	[Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
`requirePartitionFilter`	boolean
`type`	string	[Required] The only type supported is DAY, which will generate one partition per day.


                        type

string

[Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.


                        view

ViewDefinition

[Optional] The view definition.

ViewDefinition object

Properties

`query`	string	[Required] A query that BigQuery executes when the view is referenced.
`useLegacySql`	boolean	Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.
`userDefinedFunctionResources`	array [UserDefinedFunctionResource]	Describes user-defined function resources used in the query.

Responses

200Successful response

Body

Name Data Type Description

Table

Table object

Properties


                        clustering

Clustering

[Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.

Clustering object

Properties


                        fields

array []

[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.


                        creationTime

string

[Output-only] The time when this table was created, in milliseconds since the epoch.


                        description

string

[Optional] A user-friendly description of this table.


                        encryptionConfiguration

EncryptionConfiguration

Custom encryption configuration (e.g., Cloud KMS keys).

EncryptionConfiguration object

Properties


                        kmsKeyName

string

[Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.


                        etag

string

[Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.


                        expirationTime

string

[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. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.


                        externalDataConfiguration

ExternalDataConfiguration

[Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

ExternalDataConfiguration object

Properties

`autodetect`	boolean	Try to detect schema and format options automatically. Any option specified explicitly will be honored.
`bigtableOptions`	BigtableOptions	[Optional] Additional options if sourceFormat is set to BIGTABLE.
`compression`	string	[Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
`csvOptions`	CsvOptions	Additional properties to set if sourceFormat is set to CSV.
`googleSheetsOptions`	GoogleSheetsOptions	[Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
`hivePartitioningMode`	string	[Optional, Trusted Tester] Deprecated, do not use. Please set hivePartitioningOptions instead.
`hivePartitioningOptions`	HivePartitioningOptions	[Optional, Trusted Tester] Options to configure hive partitioning support.
`ignoreUnknownValues`	boolean	[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
`maxBadRecords`	integer	[Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
`schema`	TableSchema	[Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
`sourceFormat`	string	[Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
`sourceUris`	array []	[Required] 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.


                        friendlyName

string

[Optional] A descriptive name for this table.

id

string

[Output-only] An opaque ID uniquely identifying the table.


                        kind

string
Default value: bigquery#table

[Output-only] The type of the resource.


                        labels

object

The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.


                        lastModifiedTime

string

[Output-only] The time when this table was last modified, in milliseconds since the epoch.


                        location

string

[Output-only] The geographic location where the table resides. This value is inherited from the dataset.


                        materializedView

MaterializedViewDefinition

[Optional] Materialized view definition.

MaterializedViewDefinition object

Properties

`enableRefresh`	boolean	[Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".
`lastRefreshTime`	string	[Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.
`query`	string	[Required] A query whose result is persisted.
`refreshIntervalMs`	string	[Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).


                        model

ModelDefinition

[Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries.

ModelDefinition object

Properties

`modelOptions`
`trainingRuns`	array [BqmlTrainingRun]	[Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.


                        numBytes

string

[Output-only] The size of this table in bytes, excluding any data in the streaming buffer.


                        numLongTermBytes

string

[Output-only] The number of bytes in the table that are considered "long-term storage".


                        numPhysicalBytes

string

[Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.


                        numRows

string

[Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.


                        rangePartitioning

RangePartitioning

[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

RangePartitioning object

Properties

`field`	string	[TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
`range`


                        requirePartitionFilter

boolean
Default value: false

[Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.


                        schema

TableSchema

[Optional] Describes the schema of this table.

TableSchema object

Properties


                        fields

array [TableFieldSchema]

Describes the fields in a table.


                        selfLink

string

[Output-only] A URL that can be used to access this resource again.


                        streamingBuffer

Streamingbuffer

[Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

Streamingbuffer object

Properties

`estimatedBytes`	string	[Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.
`estimatedRows`	string	[Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.
`oldestEntryTime`	string	[Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.


                        tableReference

TableReference

[Required] Reference describing the ID of this table.

TableReference object

Properties

`datasetId`	string	[Required] The ID of the dataset containing this table.
`projectId`	string	[Required] The ID of the project containing this table.
`tableId`	string	[Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.


                        timePartitioning

TimePartitioning

Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

TimePartitioning object

Properties

`expirationMs`	string	[Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
`field`	string	[Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
`requirePartitionFilter`	boolean
`type`	string	[Required] The only type supported is DAY, which will generate one partition per day.


                        type

string

[Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.


                        view

ViewDefinition

[Optional] The view definition.

ViewDefinition object

Properties

`query`	string	[Required] A query that BigQuery executes when the view is referenced.
`useLegacySql`	boolean	Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.
`userDefinedFunctionResources`	array [UserDefinedFunctionResource]	Describes user-defined function resources used in the query.

PUT

/projects/{projectId}/datasets/{datasetId}/tables/{tableId}

Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource.

Request

Path

Name	Data Type	Description
`projectId`	string	Project ID of the table to update
`datasetId`	string	Dataset ID of the table to update
`tableId`	string	Table ID of the table to update

Body

Name Data Type Description

Table

Table object

Properties


                        clustering

Clustering

[Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.

Clustering object

Properties


                        fields

array []

[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.


                        creationTime

string

[Output-only] The time when this table was created, in milliseconds since the epoch.


                        description

string

[Optional] A user-friendly description of this table.


                        encryptionConfiguration

EncryptionConfiguration

Custom encryption configuration (e.g., Cloud KMS keys).

EncryptionConfiguration object

Properties


                        kmsKeyName

string

[Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.


                        etag

string

[Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.


                        expirationTime

string

[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. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.


                        externalDataConfiguration

ExternalDataConfiguration

[Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

ExternalDataConfiguration object

Properties

`autodetect`	boolean	Try to detect schema and format options automatically. Any option specified explicitly will be honored.
`bigtableOptions`	BigtableOptions	[Optional] Additional options if sourceFormat is set to BIGTABLE.
`compression`	string	[Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
`csvOptions`	CsvOptions	Additional properties to set if sourceFormat is set to CSV.
`googleSheetsOptions`	GoogleSheetsOptions	[Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
`hivePartitioningMode`	string	[Optional, Trusted Tester] Deprecated, do not use. Please set hivePartitioningOptions instead.
`hivePartitioningOptions`	HivePartitioningOptions	[Optional, Trusted Tester] Options to configure hive partitioning support.
`ignoreUnknownValues`	boolean	[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
`maxBadRecords`	integer	[Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
`schema`	TableSchema	[Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
`sourceFormat`	string	[Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
`sourceUris`	array []	[Required] 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.


                        friendlyName

string

[Optional] A descriptive name for this table.

id

string

[Output-only] An opaque ID uniquely identifying the table.


                        kind

string
Default value: bigquery#table

[Output-only] The type of the resource.


                        labels

object

The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.


                        lastModifiedTime

string

[Output-only] The time when this table was last modified, in milliseconds since the epoch.


                        location

string

[Output-only] The geographic location where the table resides. This value is inherited from the dataset.


                        materializedView

MaterializedViewDefinition

[Optional] Materialized view definition.

MaterializedViewDefinition object

Properties

`enableRefresh`	boolean	[Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".
`lastRefreshTime`	string	[Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.
`query`	string	[Required] A query whose result is persisted.
`refreshIntervalMs`	string	[Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).


                        model

ModelDefinition

[Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries.

ModelDefinition object

Properties

`modelOptions`
`trainingRuns`	array [BqmlTrainingRun]	[Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.


                        numBytes

string

[Output-only] The size of this table in bytes, excluding any data in the streaming buffer.


                        numLongTermBytes

string

[Output-only] The number of bytes in the table that are considered "long-term storage".


                        numPhysicalBytes

string

[Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.


                        numRows

string

[Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.


                        rangePartitioning

RangePartitioning

[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

RangePartitioning object

Properties

`field`	string	[TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
`range`


                        requirePartitionFilter

boolean
Default value: false

[Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.


                        schema

TableSchema

[Optional] Describes the schema of this table.

TableSchema object

Properties


                        fields

array [TableFieldSchema]

Describes the fields in a table.


                        selfLink

string

[Output-only] A URL that can be used to access this resource again.


                        streamingBuffer

Streamingbuffer

[Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

Streamingbuffer object

Properties

`estimatedBytes`	string	[Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.
`estimatedRows`	string	[Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.
`oldestEntryTime`	string	[Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.


                        tableReference

TableReference

[Required] Reference describing the ID of this table.

TableReference object

Properties

`datasetId`	string	[Required] The ID of the dataset containing this table.
`projectId`	string	[Required] The ID of the project containing this table.
`tableId`	string	[Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.


                        timePartitioning

TimePartitioning

Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

TimePartitioning object

Properties

`expirationMs`	string	[Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
`field`	string	[Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
`requirePartitionFilter`	boolean
`type`	string	[Required] The only type supported is DAY, which will generate one partition per day.


                        type

string

[Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.


                        view

ViewDefinition

[Optional] The view definition.

ViewDefinition object

Properties

`query`	string	[Required] A query that BigQuery executes when the view is referenced.
`useLegacySql`	boolean	Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.
`userDefinedFunctionResources`	array [UserDefinedFunctionResource]	Describes user-defined function resources used in the query.

Responses

200Successful response

Body

Name Data Type Description

Table

Table object

Properties


                        clustering

Clustering

[Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.

Clustering object

Properties


                        fields

array []

[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.


                        creationTime

string

[Output-only] The time when this table was created, in milliseconds since the epoch.


                        description

string

[Optional] A user-friendly description of this table.


                        encryptionConfiguration

EncryptionConfiguration

Custom encryption configuration (e.g., Cloud KMS keys).

EncryptionConfiguration object

Properties


                        kmsKeyName

string

[Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.


                        etag

string

[Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.


                        expirationTime

string

[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. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.


                        externalDataConfiguration

ExternalDataConfiguration

[Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

ExternalDataConfiguration object

Properties

`autodetect`	boolean	Try to detect schema and format options automatically. Any option specified explicitly will be honored.
`bigtableOptions`	BigtableOptions	[Optional] Additional options if sourceFormat is set to BIGTABLE.
`compression`	string	[Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
`csvOptions`	CsvOptions	Additional properties to set if sourceFormat is set to CSV.
`googleSheetsOptions`	GoogleSheetsOptions	[Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
`hivePartitioningMode`	string	[Optional, Trusted Tester] Deprecated, do not use. Please set hivePartitioningOptions instead.
`hivePartitioningOptions`	HivePartitioningOptions	[Optional, Trusted Tester] Options to configure hive partitioning support.
`ignoreUnknownValues`	boolean	[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
`maxBadRecords`	integer	[Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
`schema`	TableSchema	[Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
`sourceFormat`	string	[Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
`sourceUris`	array []	[Required] 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.


                        friendlyName

string

[Optional] A descriptive name for this table.

id

string

[Output-only] An opaque ID uniquely identifying the table.


                        kind

string
Default value: bigquery#table

[Output-only] The type of the resource.


                        labels

object

The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.


                        lastModifiedTime

string

[Output-only] The time when this table was last modified, in milliseconds since the epoch.


                        location

string

[Output-only] The geographic location where the table resides. This value is inherited from the dataset.


                        materializedView

MaterializedViewDefinition

[Optional] Materialized view definition.

MaterializedViewDefinition object

Properties

`enableRefresh`	boolean	[Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".
`lastRefreshTime`	string	[Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.
`query`	string	[Required] A query whose result is persisted.
`refreshIntervalMs`	string	[Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).


                        model

ModelDefinition

[Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries.

ModelDefinition object

Properties

`modelOptions`
`trainingRuns`	array [BqmlTrainingRun]	[Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.


                        numBytes

string

[Output-only] The size of this table in bytes, excluding any data in the streaming buffer.


                        numLongTermBytes

string

[Output-only] The number of bytes in the table that are considered "long-term storage".


                        numPhysicalBytes

string

[Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.


                        numRows

string

[Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.


                        rangePartitioning

RangePartitioning

[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

RangePartitioning object

Properties

`field`	string	[TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
`range`


                        requirePartitionFilter

boolean
Default value: false

[Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.


                        schema

TableSchema

[Optional] Describes the schema of this table.

TableSchema object

Properties


                        fields

array [TableFieldSchema]

Describes the fields in a table.


                        selfLink

string

[Output-only] A URL that can be used to access this resource again.


                        streamingBuffer

Streamingbuffer

[Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

Streamingbuffer object

Properties

`estimatedBytes`	string	[Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.
`estimatedRows`	string	[Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.
`oldestEntryTime`	string	[Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.


                        tableReference

TableReference

[Required] Reference describing the ID of this table.

TableReference object

Properties

`datasetId`	string	[Required] The ID of the dataset containing this table.
`projectId`	string	[Required] The ID of the project containing this table.
`tableId`	string	[Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.


                        timePartitioning

TimePartitioning

Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

TimePartitioning object

Properties

`expirationMs`	string	[Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
`field`	string	[Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
`requirePartitionFilter`	boolean
`type`	string	[Required] The only type supported is DAY, which will generate one partition per day.


                        type

string

[Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.


                        view

ViewDefinition

[Optional] The view definition.

ViewDefinition object

Properties

`query`	string	[Required] A query that BigQuery executes when the view is referenced.
`useLegacySql`	boolean	Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.
`userDefinedFunctionResources`	array [UserDefinedFunctionResource]	Describes user-defined function resources used in the query.

GET

/projects/{projectId}/datasets/{datasetId}/tables

Lists all tables in the specified dataset. Requires the READER dataset role.

Request

Path

Name	Data Type	Description
`projectId`	string	Project ID of the tables to list
`datasetId`	string	Dataset ID of the tables to list

Query

Name	Data Type	Description
`maxResults`	integer	Maximum number of results to return
`pageToken`	string	Page token, returned by a previous call, to request the next page of results

Responses

200Successful response

Body

Name Data Type Description

TableList

TableList object

Properties

`etag`	string	A hash of this page of results.
`kind`	string Default value: `bigquery#tableList`	The type of list.
`nextPageToken`	string	A token to request the next page of results.
`tables`	array [object]	Tables in the requested dataset.
`totalItems`	integer	The total number of tables in the dataset.

POST

/projects/{projectId}/datasets/{datasetId}/tables

Creates a new, empty table in the dataset.

Request

Path

Name	Data Type	Description
`projectId`	string	Project ID of the new table
`datasetId`	string	Dataset ID of the new table

Body

Name Data Type Description

Table

Table object

Properties


                        clustering

Clustering

[Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.

Clustering object

Properties


                        fields

array []

[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.


                        creationTime

string

[Output-only] The time when this table was created, in milliseconds since the epoch.


                        description

string

[Optional] A user-friendly description of this table.


                        encryptionConfiguration

EncryptionConfiguration

Custom encryption configuration (e.g., Cloud KMS keys).

EncryptionConfiguration object

Properties


                        kmsKeyName

string

[Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.


                        etag

string

[Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.


                        expirationTime

string

[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. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.


                        externalDataConfiguration

ExternalDataConfiguration

[Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

ExternalDataConfiguration object

Properties

`autodetect`	boolean	Try to detect schema and format options automatically. Any option specified explicitly will be honored.
`bigtableOptions`	BigtableOptions	[Optional] Additional options if sourceFormat is set to BIGTABLE.
`compression`	string	[Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
`csvOptions`	CsvOptions	Additional properties to set if sourceFormat is set to CSV.
`googleSheetsOptions`	GoogleSheetsOptions	[Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
`hivePartitioningMode`	string	[Optional, Trusted Tester] Deprecated, do not use. Please set hivePartitioningOptions instead.
`hivePartitioningOptions`	HivePartitioningOptions	[Optional, Trusted Tester] Options to configure hive partitioning support.
`ignoreUnknownValues`	boolean	[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
`maxBadRecords`	integer	[Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
`schema`	TableSchema	[Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
`sourceFormat`	string	[Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
`sourceUris`	array []	[Required] 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.


                        friendlyName

string

[Optional] A descriptive name for this table.

id

string

[Output-only] An opaque ID uniquely identifying the table.


                        kind

string
Default value: bigquery#table

[Output-only] The type of the resource.


                        labels

object

The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.


                        lastModifiedTime

string

[Output-only] The time when this table was last modified, in milliseconds since the epoch.


                        location

string

[Output-only] The geographic location where the table resides. This value is inherited from the dataset.


                        materializedView

MaterializedViewDefinition

[Optional] Materialized view definition.

MaterializedViewDefinition object

Properties

`enableRefresh`	boolean	[Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".
`lastRefreshTime`	string	[Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.
`query`	string	[Required] A query whose result is persisted.
`refreshIntervalMs`	string	[Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).


                        model

ModelDefinition

[Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries.

ModelDefinition object

Properties

`modelOptions`
`trainingRuns`	array [BqmlTrainingRun]	[Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.


                        numBytes

string

[Output-only] The size of this table in bytes, excluding any data in the streaming buffer.


                        numLongTermBytes

string

[Output-only] The number of bytes in the table that are considered "long-term storage".


                        numPhysicalBytes

string

[Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.


                        numRows

string

[Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.


                        rangePartitioning

RangePartitioning

[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

RangePartitioning object

Properties

`field`	string	[TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
`range`


                        requirePartitionFilter

boolean
Default value: false

[Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.


                        schema

TableSchema

[Optional] Describes the schema of this table.

TableSchema object

Properties


                        fields

array [TableFieldSchema]

Describes the fields in a table.


                        selfLink

string

[Output-only] A URL that can be used to access this resource again.


                        streamingBuffer

Streamingbuffer

[Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

Streamingbuffer object

Properties

`estimatedBytes`	string	[Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.
`estimatedRows`	string	[Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.
`oldestEntryTime`	string	[Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.


                        tableReference

TableReference

[Required] Reference describing the ID of this table.

TableReference object

Properties

`datasetId`	string	[Required] The ID of the dataset containing this table.
`projectId`	string	[Required] The ID of the project containing this table.
`tableId`	string	[Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.


                        timePartitioning

TimePartitioning

Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

TimePartitioning object

Properties

`expirationMs`	string	[Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
`field`	string	[Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
`requirePartitionFilter`	boolean
`type`	string	[Required] The only type supported is DAY, which will generate one partition per day.


                        type

string

[Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.


                        view

ViewDefinition

[Optional] The view definition.

ViewDefinition object

Properties

`query`	string	[Required] A query that BigQuery executes when the view is referenced.
`useLegacySql`	boolean	Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.
`userDefinedFunctionResources`	array [UserDefinedFunctionResource]	Describes user-defined function resources used in the query.

Responses

200Successful response

Body

Name Data Type Description

Table

Table object

Properties


                        clustering

Clustering

[Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.

Clustering object

Properties


                        fields

array []

[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.


                        creationTime

string

[Output-only] The time when this table was created, in milliseconds since the epoch.


                        description

string

[Optional] A user-friendly description of this table.


                        encryptionConfiguration

EncryptionConfiguration

Custom encryption configuration (e.g., Cloud KMS keys).

EncryptionConfiguration object

Properties


                        kmsKeyName

string

[Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.


                        etag

string

[Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.


                        expirationTime

string

[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. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.


                        externalDataConfiguration

ExternalDataConfiguration

[Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

ExternalDataConfiguration object

Properties

`autodetect`	boolean	Try to detect schema and format options automatically. Any option specified explicitly will be honored.
`bigtableOptions`	BigtableOptions	[Optional] Additional options if sourceFormat is set to BIGTABLE.
`compression`	string	[Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
`csvOptions`	CsvOptions	Additional properties to set if sourceFormat is set to CSV.
`googleSheetsOptions`	GoogleSheetsOptions	[Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
`hivePartitioningMode`	string	[Optional, Trusted Tester] Deprecated, do not use. Please set hivePartitioningOptions instead.
`hivePartitioningOptions`	HivePartitioningOptions	[Optional, Trusted Tester] Options to configure hive partitioning support.
`ignoreUnknownValues`	boolean	[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
`maxBadRecords`	integer	[Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
`schema`	TableSchema	[Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
`sourceFormat`	string	[Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
`sourceUris`	array []	[Required] 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.


                        friendlyName

string

[Optional] A descriptive name for this table.

id

string

[Output-only] An opaque ID uniquely identifying the table.


                        kind

string
Default value: bigquery#table

[Output-only] The type of the resource.


                        labels

object

The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.


                        lastModifiedTime

string

[Output-only] The time when this table was last modified, in milliseconds since the epoch.


                        location

string

[Output-only] The geographic location where the table resides. This value is inherited from the dataset.


                        materializedView

MaterializedViewDefinition

[Optional] Materialized view definition.

MaterializedViewDefinition object

Properties

`enableRefresh`	boolean	[Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".
`lastRefreshTime`	string	[Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.
`query`	string	[Required] A query whose result is persisted.
`refreshIntervalMs`	string	[Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).


                        model

ModelDefinition

[Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries.

ModelDefinition object

Properties

`modelOptions`
`trainingRuns`	array [BqmlTrainingRun]	[Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.


                        numBytes

string

[Output-only] The size of this table in bytes, excluding any data in the streaming buffer.


                        numLongTermBytes

string

[Output-only] The number of bytes in the table that are considered "long-term storage".


                        numPhysicalBytes

string

[Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.


                        numRows

string

[Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.


                        rangePartitioning

RangePartitioning

[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

RangePartitioning object

Properties

`field`	string	[TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
`range`


                        requirePartitionFilter

boolean
Default value: false

[Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.


                        schema

TableSchema

[Optional] Describes the schema of this table.

TableSchema object

Properties


                        fields

array [TableFieldSchema]

Describes the fields in a table.


                        selfLink

string

[Output-only] A URL that can be used to access this resource again.


                        streamingBuffer

Streamingbuffer

[Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

Streamingbuffer object

Properties

`estimatedBytes`	string	[Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.
`estimatedRows`	string	[Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.
`oldestEntryTime`	string	[Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.


                        tableReference

TableReference

[Required] Reference describing the ID of this table.

TableReference object

Properties

`datasetId`	string	[Required] The ID of the dataset containing this table.
`projectId`	string	[Required] The ID of the project containing this table.
`tableId`	string	[Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.


                        timePartitioning

TimePartitioning

Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

TimePartitioning object

Properties

`expirationMs`	string	[Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
`field`	string	[Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
`requirePartitionFilter`	boolean
`type`	string	[Required] The only type supported is DAY, which will generate one partition per day.


                        type

string

[Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.


                        view

ViewDefinition

[Optional] The view definition.

ViewDefinition object

Properties

`query`	string	[Required] A query that BigQuery executes when the view is referenced.
`useLegacySql`	boolean	Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.
`userDefinedFunctionResources`	array [UserDefinedFunctionResource]	Describes user-defined function resources used in the query.

BigQuery

Resources

datasets

Request

Path

Query

Responses

Request

Path

Responses

Body

Properties

Properties

Properties

Request

Path

Body

Properties

Properties

Properties

Responses

Body

Properties

Properties

Properties

Request

Path

Body

Properties

Properties

Properties

Responses

Body

Properties

Properties

Properties

Request

Path

Query

Responses

Body

Properties

Request

Path

Body

Properties

Properties

Properties

Responses

Body

Properties

Properties

Properties

jobs

Request

Path

Query

Responses

Body

Properties

Properties

Request

Path

Query

Responses

Body

Properties

Properties

Properties

Properties

Properties

Request

Path

Query

Responses

Body

Properties

Request

Path

Body