Skip to content

Commit

Permalink
docs: add update delay and resource-level schema to sql materializations
Browse files Browse the repository at this point in the history
  • Loading branch information
williamhbaker committed Oct 6, 2023
1 parent 544fd0e commit d811842
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -70,20 +70,23 @@ For a complete introduction to resource organization in Bigquery, see the [BigQu
| Property | Title | Description | Type | Required/Default |
|---|---|---|---|---|
| **`/project_id`**| Project ID | The project ID for the Google Cloud Storage bucket and BigQuery dataset.| String | Required |
| `/billing_project_id` | Billing project ID | The project ID to which these operations are billed in BigQuery. Typically, you want this to be the same as `project_id` (the default). | String | Same as `project_id` |
| **`/dataset`** | Dataset | Name of the target BigQuery dataset. | String | Required |
| **`/credentials_json`** | Service Account JSON | The JSON credentials of the service account to use for authorization. | String | Required |
| **`/region`** | Region | The GCS region. | String | Required |
| **`/dataset`** | Dataset | BigQuery dataset for bound collection tables (unless overridden within the binding resource configuration) as well as associated materialization metadata tables. | String | Required |
| **`/bucket`** | Bucket | Name of the GCS bucket. | String | Required |
| `/bucket_path` | Bucket path | Base path within the GCS bucket. Also called "Folder" in the GCS console. | String | |
| **`/credentials_json`** | Service Account JSON | The JSON credentials of the service account to use for authorization. | String | Required |
| `/billing_project_id` | Billing project ID | The project ID to which these operations are billed in BigQuery. Typically, you want this to be the same as `project_id` (the default). | String | Same as `project_id` |
| `/advanced` | Advanced Options | Options for advanced users. You should not typically need to modify these. | object | |
| `/advanced/updateDelay` | Update Delay | Potentially reduce compute time by increasing the delay between updates. Defaults to 30 minutes if unset. | string | |

To learn more about project billing, [see the BigQuery docs](https://cloud.google.com/billing/docs/how-to/verify-billing-enabled).

#### Bindings

| Property | Title | Description | Type | Required/Default |
|---|---|---|---|---|
| **`/table`** | Table | Table name. | string | Required |
| **`/table`** | Table | Table in the BigQuery dataset to store materialized result in. | string | Required |
| `/dataset` | Table | Alternative dataset for this table. Must be located in the region set in the endpoint configuration. | string | |
| `/delta_updates` | Delta updates. | Whether to use standard or [delta updates](#delta-updates) | boolean | false |

### Sample
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Use the below properties to configure a Snowflake materialization, which will di
| **`/host`** | Host URL | The Snowflake Host used for the connection. Example: orgname-accountname.snowflakecomputing.com (do not include the protocol). | string | Required |
| **`/password`** | Password | Snowflake user password | string | Required |
| `/role` | Role | Role assigned to the user | string | |
| **`/schema`** | Schema | Snowflake schema within the database to which to materialize | string | Required |
| **`/schema`** | Schema | Database schema for bound collection tables (unless overridden within the binding resource configuration) as well as associated materialization metadata tables | string | Required |
| **`/user`** | User | Snowflake username | string | Required |
| `/warehouse` | Warehouse | Name of the data warehouse that contains the database | string | |
| `/advanced` | Advanced Options | Options for advanced users. You should not typically need to modify these. | object | |
Expand All @@ -102,8 +102,9 @@ Use the below properties to configure a Snowflake materialization, which will di

| Property | Title | Description | Type | Required/Default |
|---|---|---|---|---|
| `/delta_updates` | Delta updates | Whether to use standard or [delta updates](#delta-updates) | boolean | |
| **`/table`** | Table | Table name | string | Required |
| `/schema` | Alternative Schema | Alternative schema for this table | string | |
| `/delta_updates` | Delta updates | Whether to use standard or [delta updates](#delta-updates) | boolean | |

### Sample

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ more of your Flow collections to your desired tables in the database.
| **`/bucket`** | S3 Staging Bucket | Name of the S3 bucket to use for staging data loads. | string | Required |
| **`/region`** | Region | Region of the S3 staging bucket. For optimal performance this should be in the same region as the Redshift database cluster. | string | Required |
| `/bucketPath` | Bucket Path | A prefix that will be used to store objects in S3. | string | |

| `/advanced` | Advanced Options | Options for advanced users. You should not typically need to modify these. | object | |
| `/advanced/updateDelay` | Update Delay | Potentially reduce active cluster time by increasing the delay between updates. Defaults to 30 minutes if unset. | string | |

#### Bindings

Expand Down

0 comments on commit d811842

Please sign in to comment.