Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Nfiann-bigquery-cloud-config #6336

Open
wants to merge 88 commits into
base: current
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
88 commits
Select commit Hold shift + click to select a range
93e76b4
Updated the dbt Cloud Big Query doc to include section on optional co…
nataliefiann Oct 22, 2024
c393a32
Added pic for dbt Cloud BigQuery optional config
nataliefiann Oct 22, 2024
3b0b94e
Merge branch 'current' into nfiann-bigquery-cloud-config
nataliefiann Oct 22, 2024
49b35a9
Merge branch 'current' into nfiann-bigquery-cloud-config
mirnawong1 Oct 23, 2024
0e0f953
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
a734d25
Merge branch 'current' into nfiann-bigquery-cloud-config
mirnawong1 Oct 23, 2024
47525e8
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
a09aef0
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
c238a6d
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
fcd0a8b
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
a844987
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
4d0f6e8
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
2b6d4f3
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
bb4a31e
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
d69d995
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
183d4e2
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
83a02f6
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
8eb63d6
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
f7323a7
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
c4c7348
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
da5c0a9
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
598b4a3
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
48612b5
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
c449173
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
7dce741
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
6aef6b0
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
f98a7f9
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
4a75093
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
4f5226b
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
e33180f
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
b190a0f
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
4f7e563
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
73b274a
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
a201666
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
df495c9
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
ae8894c
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
6ffd25b
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 23, 2024
e843de7
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 24, 2024
d7ddac4
Merge branch 'current' into nfiann-bigquery-cloud-config
mirnawong1 Oct 24, 2024
14a3c43
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
6587b20
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
7ed1629
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
9d9b811
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
e881662
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
40282c0
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
486040f
Merge branch 'current' into nfiann-bigquery-cloud-config
mirnawong1 Oct 25, 2024
11d42d7
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
f80f04a
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
2f135e2
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
2b62221
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
7064037
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
e2cc88b
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
a5eca1a
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
dce4826
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
01ed823
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
63e9edb
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
31267ad
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
532351e
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
48966b8
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
d22a5fa
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
62ff36d
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
59a4d35
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
723be19
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
920f69e
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
4e66834
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
7a47601
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
6fb6313
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
0a099c1
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
051d54b
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
6cf71f5
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
87ad314
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
1a08896
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
2cefee4
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
b4e390d
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
73ac81e
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
911167f
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
db79248
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
71f0532
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
84fb2ae
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
d2899b3
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
ee72437
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
be823b2
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
a5aaff9
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
2b73ea7
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
6981c64
Update website/docs/docs/cloud/connect-data-platform/connnect-bigquer…
nataliefiann Oct 25, 2024
aa8130a
Merge branch 'current' into nfiann-bigquery-cloud-config
nataliefiann Oct 25, 2024
513cce6
Update connnect-bigquery.md
mirnawong1 Oct 25, 2024
28151ca
Added two tables
nataliefiann Oct 25, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 120 additions & 0 deletions website/docs/docs/cloud/connect-data-platform/connnect-bigquery.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,122 @@ As an end user, if your organization has set up BigQuery OAuth, you can link a p

To learn how to optimize performance with data platform-specific configurations in dbt Cloud, refer to [BigQuery-specific configuration](/reference/resource-configs/bigquery-configs).

### Optional configurations

In BigQuery, optional configurations let you tailor settings for tasks such as query priority, dataset location, job timeout, and more. These options give you greater control over how BigQuery functions behind the scenes to meet your requirements.

To customize your optional configurations in dbt Cloud:

nataliefiann marked this conversation as resolved.
Show resolved Hide resolved
- Click your name at the bottom left-hand side bar menu in dbt Cloud
- Select **Profile** from the menu
- From there, click **Project** and select your BigQuery project
- Select your BigQuery project from the left-hand menu
nataliefiann marked this conversation as resolved.
Show resolved Hide resolved
- Click **Settings** towards the top right and a **Project details** window will open
- Scroll down to **Development Connection** and select BigQuery
- Click **Edit** and then scroll down to **Optional settings**

<Lightbox src="/img/bigquery/bigquery-optional-config.png" width="70%" title="BigQuery optional configuration"/>

The following are the optional configs you can set in dbt Cloud:
nataliefiann marked this conversation as resolved.
Show resolved Hide resolved

| Config | Information | Type | Example |
|--------------------------------|------------------------------------------------------------------------------------------------------------------------------|---------|-----------------------------|
| Priority | Sets the priority for BigQuery jobs (either immediate or queued for batch processing) | String | `batch` or `interactive` |
| Retries | Specifies the number of retries for failed jobs due to temporary issues | Integer | `3` |
| Location | Location for creating new datasets | String | `US`, `EU`, `us-west2` |
| Maximum bytes billed | Limits the maximum number of bytes that can be billed for a query | Integer | `1000000000` |
| Impersonate service account | Allows users authenticated locally to access BigQuery resources under a specified service account | String | `service-account@project.iam.gserviceaccount.com` |
| Execution project | Specifies the project ID to bill for query execution | String | `my-project-id` |
| Job retry deadline seconds | Sets the total number of seconds BigQuery will attempt to retry a job if it fails | Integer | `600` |
| Job creation timeout seconds | Specifies the maximum timeout for the job creation step | Integer | `120` |
| Google Cloud Storage bucket | Location for storing objects in Google Cloud Storage | String | `my-bucket` |
| Dataproc region | Specifies the cloud region for running data processing jobs | String | `US`, `EU`, `asia-northeast1` |
| Dataproc cluster name | Assigns a unique identifier to a group of virtual machines in Dataproc | String | `my-cluster` |


<Expandable alt_header="Priority">

The `priority` for the BigQuery jobs that dbt executes can be configured with the `priority` configuration in your BigQuery profile. The priority field can be set to one of `batch` or `interactive`. For more information on query priority, consult the [BigQuery documentation](https://cloud.google.com/bigquery/docs/running-queries).

</Expandable>

<Expandable alt_header="Retries">

Retries in BigQuery help to ensure that jobs complete successfully by trying again after temporary failures, making your operations more robust and reliable.

</Expandable>

<Expandable alt_header="Location">

The `location` of BigQuery datasets can be set using the `location` setting in a BigQuery profile. As per the [BigQuery documentation](https://cloud.google.com/bigquery/docs/locations), `location` may be either a multi-regional location (for example, `EU`, `US`), or a regional location (like `us-west2`).

</Expandable>

nataliefiann marked this conversation as resolved.
Show resolved Hide resolved
<Expandable alt_header="Maximum bytes build">

When a `maximum_bytes_billed` value is configured for a BigQuery profile, that allows you to limit how much data your query can process. It’s a safeguard to prevent your query from accidentally processing more data than you expect, which could lead to higher costs. Queries executed by dbt will fail if they exceed the configured maximum bytes threshhold. This configuration should be supplied as an integer number of bytes.

If your `maximum_bytes_billed` is 1000000000, you would enter that value in the `maximum_bytes_billed` field in dbt cloud.

nataliefiann marked this conversation as resolved.
Show resolved Hide resolved
| Config | Description | Type | Example |
| ---------------- | ------------------------------------------------------------------------| ------- | -------- |
| Max bytes billed | The max number of bytes that can be billed for a given BigQuery query | Integer | `1000000000` |

</Expandable>

<Expandable alt_header="Execution project">

By default, dbt will use the specified `project`/`database` as both:

1. The location to materialize resources (models, seeds, snapshots, and so on), unless they specify a custom project/database config
2. The GCP project that receives the bill for query costs or slot usage

Optionally, you may specify an execution project to bill for query execution, instead of the project/database where you materialize most resources.
nataliefiann marked this conversation as resolved.
Show resolved Hide resolved

</Expandable>

<Expandable alt_header="Impersonate service account">

This feature allows users authenticating using local OAuth to access BigQuery resources based on the permissions of a service account.

For a general overview of this process, see the official docs for [Creating Short-lived Service Account Credentials](https://cloud.google.com/iam/docs/create-short-lived-credentials-direct).
nataliefiann marked this conversation as resolved.
Show resolved Hide resolved

</Expandable>

<Expandable alt_header="Job retry deadline seconds">

Job retry deadline seconds is the maximum amount of time BigQuery will spend retrying a job before it gives up.
nataliefiann marked this conversation as resolved.
Show resolved Hide resolved

</Expandable>

<Expandable alt_header="Job creation timeout seconds">

Job creation timeout seconds is the maximum time BigQuery will wait to start the job. If the job doesn’t start within that time, it times out.
nataliefiann marked this conversation as resolved.
Show resolved Hide resolved

</Expandable>

<Expandable alt_header="Google cloud storage bucket">

Everything you store in Cloud Storage must be placed inside a [bucket](https://cloud.google.com/storage/docs/buckets). Buckets help you organize your data and manage access to it.
nataliefiann marked this conversation as resolved.
Show resolved Hide resolved

</Expandable>

<Expandable alt_header="Dataproc region">

A designated location in the cloud where you can run your data processing jobs efficiently. This region must match the location of your BigQuery dataset if you want to use Dataproc with BigQuery to ensure data doesn't move across regions, which can be inefficient and costly.

For more information on [dataproc regions](https://cloud.google.com/bigquery/docs/locations), refer to the BigQuery documentation.
nataliefiann marked this conversation as resolved.
Show resolved Hide resolved

</Expandable>

<Expandable alt_header="Dataproc cluster name">

A unique label you give to your group of virtual machines to help you identify and manage your data processing tasks in the cloud. When you integrate Dataproc with BigQuery, you need to provide the cluster name so BigQuery knows which specific set of resources (the cluster) to use for running the data jobs.

Have a look at [Dataproc's document on Create a cluster](https://cloud.google.com/dataproc/docs/guides/create-cluster) for an overview on how clusters work.
nataliefiann marked this conversation as resolved.
Show resolved Hide resolved

</Expandable>

### Account level connections and credential management

You can re-use connections across multiple projects with [global connections](/docs/cloud/connect-data-platform/about-connections#migration-from-project-level-connections-to-account-level-connections). Connections are attached at the environment level (formerly project level), so you can utilize multiple connections inside of a single project (to handle dev, staging, production, etc.).
Expand Down Expand Up @@ -147,3 +263,7 @@ For a project, you will first create an environment variable to store the secret
"extended_attributes_id": FFFFF
}'
```




Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading