Update dataset access

Update a dataset's access controls.

Code sample

Go

Before trying this sample, follow the Go setup instructions in the BigQuery quickstart using client libraries . For more information, see the BigQuery Go API reference documentation .

To authenticate to BigQuery, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "cloud.google.com/go/bigquery" 
 ) 
 // updateDatasetAccessControl demonstrates how the access control policy of a dataset 
 // can be amended by adding an additional entry corresponding to a specific user identity. 
 func 
  
 updateDatasetAccessControl 
 ( 
 projectID 
 , 
  
 datasetID 
  
 string 
 ) 
  
 error 
  
 { 
  
 // projectID := "my-project-id" 
  
 // datasetID := "mydataset" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 client 
 , 
  
 err 
  
 := 
  
 bigquery 
 . 
 NewClient 
 ( 
 ctx 
 , 
  
 projectID 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "bigquery.NewClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 client 
 . 
 Close 
 () 
  
 ds 
  
 := 
  
 client 
 . 
 Dataset 
 ( 
 datasetID 
 ) 
  
 meta 
 , 
  
 err 
  
 := 
  
 ds 
 . 
 Metadata 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 err 
  
 } 
  
 // Append a new access control entry to the existing access list. 
  
 update 
  
 := 
  
 bigquery 
 . 
  DatasetMetadataToUpdate 
 
 { 
  
 Access 
 : 
  
 append 
 ( 
 meta 
 . 
 Access 
 , 
  
& bigquery 
 . 
  AccessEntry 
 
 { 
  
 Role 
 : 
  
 bigquery 
 . 
  ReaderRole 
 
 , 
  
 EntityType 
 : 
  
 bigquery 
 . 
  UserEmailEntity 
 
 , 
  
 Entity 
 : 
  
 "sample.bigquery.dev@gmail.com" 
 }, 
  
 ), 
  
 } 
  
 // Leverage the ETag for the update to assert there's been no modifications to the 
  
 // dataset since the metadata was originally read. 
  
 if 
  
 _ 
 , 
  
 err 
  
 := 
  
 ds 
 . 
 Update 
 ( 
 ctx 
 , 
  
 update 
 , 
  
 meta 
 . 
 ETag 
 ); 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 err 
  
 } 
  
 return 
  
 nil 
 } 
 

Java

Before trying this sample, follow the Java setup instructions in the BigQuery quickstart using client libraries . For more information, see the BigQuery Java API reference documentation .

To authenticate to BigQuery, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  import 
  
 com.google.cloud.bigquery. Acl 
 
 ; 
 import 
  
 com.google.cloud.bigquery. Acl 
. Role 
 
 ; 
 import 
  
 com.google.cloud.bigquery. Acl 
. User 
 
 ; 
 import 
  
 com.google.cloud.bigquery. BigQuery 
 
 ; 
 import 
  
 com.google.cloud.bigquery. BigQueryException 
 
 ; 
 import 
  
 com.google.cloud.bigquery. BigQueryOptions 
 
 ; 
 import 
  
 com.google.cloud.bigquery. Dataset 
 
 ; 
 import 
  
 java.util.ArrayList 
 ; 
 public 
  
 class 
 UpdateDatasetAccess 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 String 
  
 datasetName 
  
 = 
  
 "MY_DATASET_NAME" 
 ; 
  
 // Create a new ACL granting the READER role to "sample.bigquery.dev@gmail.com" 
  
 // For more information on the types of ACLs available see: 
  
 // https://cloud.google.com/storage/docs/access-control/lists 
  
  Acl 
 
  
 newEntry 
  
 = 
  
  Acl 
 
 . 
 of 
 ( 
 new 
  
  User 
 
 ( 
 "sample.bigquery.dev@gmail.com" 
 ), 
  
  Role 
 
 . 
 READER 
 ); 
  
 updateDatasetAccess 
 ( 
 datasetName 
 , 
  
 newEntry 
 ); 
  
 } 
  
 public 
  
 static 
  
 void 
  
 updateDatasetAccess 
 ( 
 String 
  
 datasetName 
 , 
  
  Acl 
 
  
 newEntry 
 ) 
  
 { 
  
 try 
  
 { 
  
 // Initialize client that will be used to send requests. This client only needs to be created 
  
 // once, and can be reused for multiple requests. 
  
  BigQuery 
 
  
 bigquery 
  
 = 
  
  BigQueryOptions 
 
 . 
 getDefaultInstance 
 (). 
 getService 
 (); 
  
  Dataset 
 
  
 dataset 
  
 = 
  
 bigquery 
 . 
  getDataset 
 
 ( 
 datasetName 
 ); 
  
 // Get a copy of the ACLs list from the dataset and append the new entry 
  
 ArrayList<Acl> 
  
 acls 
  
 = 
  
 new 
  
 ArrayList 
<> ( 
 dataset 
 . 
  getAcl 
 
 ()); 
  
 acls 
 . 
 add 
 ( 
 newEntry 
 ); 
  
 bigquery 
 . 
  update 
 
 ( 
 dataset 
 . 
 toBuilder 
 (). 
 setAcl 
 ( 
 acls 
 ). 
 build 
 ()); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Dataset Access Control updated successfully" 
 ); 
  
 } 
  
 catch 
  
 ( 
  BigQueryException 
 
  
 e 
 ) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Dataset Access control was not updated \n" 
  
 + 
  
 e 
 . 
 toString 
 ()); 
  
 } 
  
 } 
 } 
 

Node.js

Before trying this sample, follow the Node.js setup instructions in the BigQuery quickstart using client libraries . For more information, see the BigQuery Node.js API reference documentation .

To authenticate to BigQuery, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  // Import the Google Cloud client library 
 const 
  
 { 
 BigQuery 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/bigquery 
' 
 ); 
 const 
  
 bigquery 
  
 = 
  
 new 
  
  BigQuery 
 
 (); 
 async 
  
 function 
  
 updateDatasetAccess 
 () 
  
 { 
  
 // Update a datasets's access controls. 
  
 /** 
 * TODO(developer): Uncomment the following lines before running the sample. 
 */ 
  
 // const datasetId = "my_dataset"; 
  
 // Create new role metadata 
  
 const 
  
 newRole 
  
 = 
  
 { 
  
 role 
 : 
  
 'READER' 
 , 
  
 entity_type 
 : 
  
 'userByEmail' 
 , 
  
 userByEmail 
 : 
  
 'sample.bigquery.dev@gmail.com' 
 , 
  
 }; 
  
 // Retreive current dataset metadata 
  
 const 
  
 dataset 
  
 = 
  
 bigquery 
 . 
 dataset 
 ( 
 datasetId 
 ); 
  
 const 
  
 [ 
 metadata 
 ] 
  
 = 
  
 await 
  
 dataset 
 . 
 getMetadata 
 (); 
  
 // Add new role to role acess array 
  
 metadata 
 . 
 access 
 . 
 push 
 ( 
 newRole 
 ); 
  
 const 
  
 [ 
 apiResponse 
 ] 
  
 = 
  
 await 
  
 dataset 
 . 
 setMetadata 
 ( 
 metadata 
 ); 
  
 const 
  
 newAccessRoles 
  
 = 
  
 apiResponse 
 . 
 access 
 ; 
  
 newAccessRoles 
 . 
 forEach 
 ( 
 role 
  
 = 
>  
 console 
 . 
 log 
 ( 
 role 
 )); 
 } 
 

Python

Before trying this sample, follow the Python setup instructions in the BigQuery quickstart using client libraries . For more information, see the BigQuery Python API reference documentation .

To authenticate to BigQuery, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  # TODO(developer): Set dataset_id to the ID of the dataset to fetch. 
 dataset_id 
 = 
 "your-project.your_dataset" 
 # TODO(developer): Set entity_id to the ID of the email or group from whom 
 # you are adding access. Alternatively, to the JSON REST API representation 
 # of the entity, such as a view's table reference. 
 entity_id 
 = 
 "user-or-group-to-add@example.com" 
 from 
  
 google.cloud.bigquery.enums 
  
 import 
  EntityTypes 
 
 # TODO(developer): Set entity_type to the type of entity you are granting access to. 
 # Common types include: 
 # 
 # * "userByEmail" -- A single user or service account. For example "fred@example.com" 
 # * "groupByEmail" -- A group of users. For example "example@googlegroups.com" 
 # * "view" -- An authorized view. For example 
 #       {"projectId": "p", "datasetId": "d", "tableId": "v"} 
 # 
 # For a complete reference, see the REST API reference documentation: 
 # https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#Dataset.FIELDS.access 
 entity_type 
 = 
  EntityTypes 
 
 . 
 GROUP_BY_EMAIL 
 # TODO(developer): Set role to a one of the "Basic roles for datasets" 
 # described here: 
 # https://cloud.google.com/bigquery/docs/access-control-basic-roles#dataset-basic-roles 
 role 
 = 
 "READER" 
 from 
  
 google.cloud 
  
 import 
  bigquery 
 
 # Construct a BigQuery client object. 
 client 
 = 
  bigquery 
 
 . 
  Client 
 
 () 
 dataset 
 = 
 client 
 . 
  get_dataset 
 
 ( 
 dataset_id 
 ) 
 # Make an API request. 
 entries 
 = 
 list 
 ( 
 dataset 
 . 
  access_entries 
 
 ) 
 entries 
 . 
 append 
 ( 
  bigquery 
 
 . 
  AccessEntry 
 
 ( 
 role 
 = 
 role 
 , 
 entity_type 
 = 
 entity_type 
 , 
 entity_id 
 = 
 entity_id 
 , 
 ) 
 ) 
 dataset 
 . 
  access_entries 
 
 = 
 entries 
 dataset 
 = 
 client 
 . 
  update_dataset 
 
 ( 
 dataset 
 , 
 [ 
 "access_entries" 
 ]) 
 # Make an API request. 
 full_dataset_id 
 = 
 " 
 {} 
 . 
 {} 
 " 
 . 
 format 
 ( 
 dataset 
 . 
 project 
 , 
 dataset 
 . 
 dataset_id 
 ) 
 print 
 ( 
 "Updated dataset ' 
 {} 
 ' with modified user permissions." 
 . 
 format 
 ( 
 full_dataset_id 
 ) 
 ) 
 

What's next

To search and filter code samples for other Google Cloud products, see the Google Cloud sample browser .

Create a Mobile Website
View Site in Mobile | Classic
Share by: