Datasets: update

Requires authorization

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. Try it now .

Warning: The specified access list completely overwrites the existing access list. If you specify an empty access list, you will revoke access to everyone except yourself; you cannot remove all owners from a dataset.

Required ACLs: To call this method, you must have one of the following rights:

Dataset OWNER

Request

HTTP request

PUT https://www.googleapis.com/bigquery/v2/projects/projectId/datasets/datasetId

Parameters

Parameter name	Value	Description
Path parameters
`datasetId`	`string`	Dataset ID of the dataset being updated
`projectId`	`string`	Project ID of the dataset being updated

Authorization

This request requires authorization with at least one of the following scopes ( read more about authentication and authorization ).

Scope
`https://www.googleapis.com/auth/bigquery`
`https://www.googleapis.com/auth/cloud-platform`

Request body

In the request body, supply a Datasets resource with the following properties:

Property name	Value	Description	Notes
Required Properties
`datasetReference. datasetId`	`string`	[Required] A unique ID for this dataset, without the project name.
`datasetReference. projectId`	`string`	[Optional] The ID of the container project.
Optional Properties
`access[]. domain`	`string`	[Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".	writable
`access[]. groupByEmail`	`string`	[Pick one] An email address of a Google Group to grant access to.	writable
`access[]. role`	`string`	[Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: `READER` , `WRITER` , `OWNER` . For more information about access control in BigQuery, see access control .	writable
`access[]. specialGroup`	`string`	[Pick one] A special group to grant access to. Possible values include: `projectOwners` : Owners of the enclosing project. `projectReaders` : Readers of the enclosing project. `projectWriters` : Writers of the enclosing project. `allAuthenticatedUsers` : All authenticated BigQuery users. For more information about access control in BigQuery, see access control .	writable
`access[]. userByEmail`	`string`	[Pick one] An email address of a user to grant access to. For example: [email protected].	writable
`description`	`string`	[Optional] A user-friendly description of the dataset.	writable
`friendlyName`	`string`	[Optional] A descriptive name for the dataset.	writable

Response

If successful, this method returns a Datasets resource in the response body.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Google BigQuery