From 2131911cbfd39e7633f80e8aeacd856b47f2be4a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Carlos=20Jos=C3=A9=20Camacho?= Date: Thu, 7 Sep 2023 14:59:02 -0600 Subject: [PATCH] DH-4617 Improve bigquery tutorial paragraph (#152) --- README.md | 7 +++++-- docs/api.database.rst | 7 +++++-- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b15a7bfa..1f8bda3b 100644 --- a/README.md +++ b/README.md @@ -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` diff --git a/docs/api.database.rst b/docs/api.database.rst index 21f3262f..9acdde71 100644 --- a/docs/api.database.rst +++ b/docs/api.database.rst @@ -151,8 +151,11 @@ Example:: BigQuery ^^^^^^^^^^^^ -To connect to BigQuery you should create a json credential file. You can -follow this `tutorial `_ 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 `_. + + 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::