geido commented on a change in pull request #17191: URL: https://github.com/apache/superset/pull/17191#discussion_r734394385
########## File path: docs/src/pages/docs/Connecting to Databases/google-bigquery.mdx ########## @@ -11,31 +11,55 @@ version: 1 The recommended connector library for BigQuery is [pybigquery](https://github.com/mxmzdlv/pybigquery). -The connection string for BigQuery looks like: - +### Install BigQuery Driver +Follow steps [here](/docs/databases/dockeradddrivers) about how to +install new database drivers when setting up Superset locally via docker-compose. ``` -bigquery://{project_id} +echo "pybigquery" >> ./docker/requirements-local.txt ``` - -When adding a new BigQuery connection in Superset, you'll also need to add the GCP Service Account +### Connecting to BigQuery +When adding a new BigQuery connection in Superset, you'll need to add the GCP Service Account credentials file (as a JSON). 1. Create your Service Account via the Google Cloud Platform control panel, provide it access to the appropriate BigQuery datasets, and download the JSON configuration file for the service account. - -2. n Superset, Add a JSON blob to the **Secure Extra** field in the database configuration form with - the following format: - +2. In Superset, you can either upload that JSON or add the JSON blob in the following format (this should be the content of your credential JSON file): ``` { - "credentials_info": <contents of credentials JSON file> -} -``` + "type": "service_account", + "project_id": "...", + "private_key_id": "...", + "private_key": "...", + "client_email": "...", + "client_id": "...", + "auth_uri": "...", + "token_uri": "...", + "auth_provider_x509_cert_url": "...", + "client_x509_cert_url": "..." + } + ``` -The resulting file should have this structure: + -``` -{ + +3. Additionally, can connect via SQLAlchemy URI instead + + The connection string for BigQuery looks like: + + ``` + bigquery://{project_id} + ``` + Go to **Advance** tab, Add a JSON blob to the **Secure Extra** field in the database configuration form with Review comment: ```suggestion Go to the **Advanced** tab, Add a JSON blob to the **Secure Extra** field in the database configuration form with ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
