Skip to content

Commit

Permalink
DH-4617 Improve bigquery tutorial paragraph
Browse files Browse the repository at this point in the history
  • Loading branch information
jcjc712 committed Sep 7, 2023
1 parent d5cb9d2 commit e0cdb13
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,8 +215,11 @@ You can generate the `connection_uri` parameter in the API call for each of the
```

**BigQuery**
To connect to BigQuery you should create a credential file, this is a json file, you can
follow this [tutorial](https://www.privacydynamics.io/docs/connections/bigquery.html) to generate it.
To connect to BigQuery you should create a json credential file. Please follow Steps 1-3 under "Configure
BigQuery Authentication in Google Cloud Platform" in
this [tutorial](https://www.privacydynamics.io/docs/connections/bigquery.html).

> IMPORTANT: Please ensure the service account only has **"Viewer"** permissions.
Once you have your credential json file you can store it inside this project for example I created the folder
`private_credentials` and inside I stored my credential file `my-db-123456acbd.json`
Expand Down
7 changes: 5 additions & 2 deletions docs/api.database.rst
Original file line number Diff line number Diff line change
Expand Up @@ -151,8 +151,11 @@ Example::
BigQuery
^^^^^^^^^^^^

To connect to BigQuery you should create a json credential file. You can
follow this `tutorial <https://www.privacydynamics.io/docs/connections/bigquery.html>`_ to generate it.
To connect to BigQuery you should create a json credential file. Please follow Steps 1-3 under "Configure BigQuery
Authentication in Google Cloud Platform" in
this `tutorial <https://www.privacydynamics.io/docs/connections/bigquery.html>`_.

Please ensure the service account only has **"Viewer"** permissions.

Once you have your credential json file you can store it inside the project. For example given the credential file `my-db-123456acbd.json`
in the folder `private_credentials` you should set in the endpoint param `path_to_credentials_file` the path, for example::
Expand Down

0 comments on commit e0cdb13

Please sign in to comment.