Skip to content

Commit

Permalink
Merge branch 'current' into dbeatty10-patch-3
Browse files Browse the repository at this point in the history
  • Loading branch information
dbeatty10 authored Sep 24, 2024
2 parents 4a033ee + 19dea92 commit 1532a4d
Show file tree
Hide file tree
Showing 10 changed files with 53 additions and 38 deletions.
40 changes: 24 additions & 16 deletions website/docs/docs/cloud/configure-cloud-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,21 +52,29 @@ Once you install the dbt Cloud CLI, you need to configure it to connect to a dbt

The config file looks like this:

```yaml
version: "1"
context:
active-project: "<project id from the list below>"
active-host: "<active host from the list>"
defer-env-id: "<optional defer environment id>"
projects:
- project-id: "<project-id>"
account-host: "<account-host>"
api-key: "<user-api-key>"

- project-id: "<project-id>"
account-host: "<account-host>"
api-key: "<user-api-key>"
```
```yaml
version: "1"
context:
active-project: "<project id from the list below>"
active-host: "<active host from the list>"
defer-env-id: "<optional defer environment id>"
projects:
- project-name: "<project-name>"
project-id: "<project-id>"
account-name: "<account-name>"
account-id: "<account-id>"
account-host: "<account-host>" # for example, "cloud.getdbt.com"
token-name: "<pat-or-service-token-name>"
token-value: "<pat-or-service-token-value>"

- project-name: "<project-name>"
project-id: "<project-id>"
account-name: "<account-name>"
account-id: "<account-id>"
account-host: "<account-host>" # for example, "cloud.getdbt.com"
token-name: "<pat-or-service-token-name>"
token-value: "<pat-or-service-token-value>"
```
3. After downloading the config file and creating your directory, navigate to a dbt project in your terminal:
Expand Down Expand Up @@ -195,4 +203,4 @@ This command moves the `dbt_cloud.yml` from the `Downloads` folder to the `.dbt`
By default, [all artifacts](/reference/artifacts/dbt-artifacts) are downloaded when you execute dbt commands from the dbt Cloud CLI. To skip these files from being downloaded, add `--download-artifacts=false` to the command you want to run. This can help improve run-time performance but might break workflows that depend on assets like the [manifest](/reference/artifacts/manifest-json).


</Expandable>
</Expandable>
33 changes: 15 additions & 18 deletions website/docs/guides/databricks-qs.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,36 +41,33 @@ You can check out [dbt Fundamentals](https://learn.getdbt.com/courses/dbt-fundam

## Create a Databricks workspace

1. Use your existing account or [sign up for a Databricks account](https://databricks.com/). Complete the form with your user information.
1. Use your existing account or [sign up for a Databricks account](https://databricks.com/). Complete the form with your user information and click **Continue**.

<div style={{maxWidth: '400px'}}>
<Lightbox src="/img/databricks_tutorial/images/signup_form.png" title="Sign up for Databricks" />
</div>

2. For the purpose of this tutorial, you will be selecting AWS as our cloud provider but if you use Azure or GCP internally, please choose one of them. The setup process will be similar.
3. Check your email to complete the verification process.
4. After setting up your password, you will be guided to choose a subscription plan. Select the `Premium` or `Enterprise` plan to access the SQL Compute functionality required for using the SQL warehouse for dbt. We have chosen `Premium` for this tutorial. Click **Continue** after selecting your plan.

<div style={{maxWidth: '400px'}}>
<Lightbox src="/img/databricks_tutorial/images/choose_plan.png" title="Choose Databricks Plan" />
2. On the next screen, select your cloud provider. This tutorial uses AWS as the cloud provider, but if you use Azure or GCP internally, please select your platform. The setup process will be similar. Do not select the **Get started with Community Edition** option, as this will not provide the required compute for this guide.

<div style={{maxWidth: '400px'}}>
<Lightbox src="/img/databricks_tutorial/images/choose_provider.png" title="Choose cloud provider" />
</div>

5. Click **Get Started** when you come to this below page and then **Confirm** after you validate that you have everything needed.
3. Check your email and complete the verification process.

4. After completing the verification processes, you will be brought to the first setup screen. Databricks defaults to the `Premium` plan and you can change the trial to `Enterprise` on this page.

<div style={{maxWidth: '400px'}}>
<Lightbox src="/img/databricks_tutorial/images/validate_1.png" />
</div>
<div style={{maxWidth: '400px'}}>
<Lightbox src="/img/databricks_tutorial/images/validate_2.png" />
<Lightbox src="/img/databricks_tutorial/images/choose_plan.png" title="Choose Databricks Plan" />
</div>

6. Now it's time to create your first workspace. A Databricks workspace is an environment for accessing all of your Databricks assets. The workspace organizes objects like notebooks, SQL warehouses, clusters, etc into one place. Provide the name of your workspace and choose the appropriate AWS region and click **Start Quickstart**. You might get the checkbox of **I have data in S3 that I want to query with Databricks**. You do not need to check this off for the purpose of this tutorial.
5. Now, it's time to create your first workspace. A Databricks workspace is an environment for accessing all of your Databricks assets. The workspace organizes objects like notebooks, SQL warehouses, clusters, and more so into one place. Provide the name of your workspace, choose the appropriate AWS region, and click **Start Quickstart**. You might get the checkbox of **I have data in S3 that I want to query with Databricks**. You do not need to check this off for this tutorial.

<div style={{maxWidth: '400px'}}>
<Lightbox src="/img/databricks_tutorial/images/setup_first_workspace.png" title="Setup First Workspace" />
<Lightbox src="/img/databricks_tutorial/images/start_quickstart.png" title="Create AWS resources" />
</div>

7. By clicking on `Start Quickstart`, you will be redirected to AWS and asked to log in if you haven’t already. After logging in, you should see a page similar to this.
6. By clicking on `Start Quickstart`, you will be redirected to AWS and asked to log in if you haven’t already. After logging in, you should see a page similar to this.

<div style={{maxWidth: '400px'}}>
<Lightbox src="/img/databricks_tutorial/images/quick_create_stack.png" title="Create AWS resources" />
Expand All @@ -80,7 +77,7 @@ You can check out [dbt Fundamentals](https://learn.getdbt.com/courses/dbt-fundam
If you get a session error and don’t get redirected to this page, you can go back to the Databricks UI and create a workspace from the interface. All you have to do is click **create workspaces**, choose the quickstart, fill out the form and click **Start Quickstart**.
:::

8. There is no need to change any of the pre-filled out fields in the Parameters. Just add in your Databricks password under **Databricks Account Credentials**. Check off the Acknowledgement and click **Create stack**.
7. There is no need to change any of the pre-filled out fields in the Parameters. Just add in your Databricks password under **Databricks Account Credentials**. Check off the Acknowledgement and click **Create stack**.
<div style={{maxWidth: '400px'}}>
<Lightbox src="/img/databricks_tutorial/images/parameters.png" title="Parameters" />
</div>
Expand All @@ -89,11 +86,11 @@ If you get a session error and don’t get redirected to this page, you can go b
<Lightbox src="/img/databricks_tutorial/images/create_stack.png" title="Capabilities" />
</div>

10. Go back to the Databricks tab. You should see that your workspace is ready to use.
8. Go back to the Databricks tab. You should see that your workspace is ready to use.
<div style={{maxWidth: '400px'}}>
<Lightbox src="/img/databricks_tutorial/images/workspaces.png" title="A Databricks Workspace" />
</div>
11. Now let’s jump into the workspace. Click **Open** and log into the workspace using the same login as you used to log into the account.
9. Now let’s jump into the workspace. Click **Open** and log into the workspace using the same login as you used to log into the account.

## Load data

Expand Down
2 changes: 1 addition & 1 deletion website/docs/reference/global-configs/resource-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The available resource types are:

## Example

Instead of targeting specific resources, use the `--resource-flag` or `--exclude-resource-type` flags to target all resources of a certain type: `dbt build --resource-type RESOURCE_TYPE` replacing `RESOURCE_TYPE` with the resource type you want to exclude.
Instead of targeting specific resources, use the `--resource-flag` or `--exclude-resource-type` flags to target all resources of a certain type: `dbt build --resource-type RESOURCE_TYPE` replacing `RESOURCE_TYPE` with the resource type you want to include.

- For example, use the following command to include _all_ snapshots from your dbt build process:

Expand Down
3 changes: 2 additions & 1 deletion website/docs/reference/resource-configs/grants.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,13 +249,14 @@ models:

<div warehouse="Redshift">

* Granting to / revoking from is only fully supported for Redshift users (not groups or roles).
* Granting to / revoking from is only fully supported for Redshift users (not [groups](https://docs.aws.amazon.com/redshift/latest/dg/r_Groups.html) or [roles](https://docs.aws.amazon.com/redshift/latest/dg/r_roles-managing.html)).

</div>

<div warehouse="Snowflake">

* dbt accounts for the [`copy_grants` configuration](/reference/resource-configs/snowflake-configs#copying-grants) when calculating which grants need to be added or removed.
* Granting to / revoking from is only fully supported for Snowflake roles (not [database roles](https://docs.snowflake.com/user-guide/security-access-control-overview#types-of-roles)).

</div>

Expand Down
9 changes: 9 additions & 0 deletions website/docs/reference/resource-configs/schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,15 @@ This results in the generated relation being located in the `snapshots` schema s

</TabItem>

<TabItem value="saved-queries" label="Saved queries">

<File name='dbt_project.yml'>
```yml
saved-queries:
+schema: metrics
```
</File>
</TabItem>
<TabItem value="tests" label="Test">

Customize the schema for storing test results in your `dbt_project.yml` file.
Expand Down
4 changes: 2 additions & 2 deletions website/docs/terms/json.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Individual values from an array can be called by referencing the location of a v

Dictionaries and arrays can be nested in JSON objects as well as nested in each other. **Dictionaries and arrays can only be values. They can never be keys.**

Here’s an example of a JSON object describing a tweet from [Twitter’s developer platform](https://developer.twitter.com/en/docs/twitter-api/v1/data-dictionary/overview).
Here’s an example of a JSON object describing a tweet from [X's (formerly Twitter) developer platform](https://developer.x.com/en/docs/twitter-api/v1/data-dictionary/overview).

```json
tweet =
Expand Down Expand Up @@ -100,4 +100,4 @@ JSON is lightweight and often used to transfer data over a network connection. A

## Conclusion

The greatest strength of JSON also acts as its weakness—the data it contains informs the shape the object takes, rather than the other way around. Structured data is the bread and butter of analytics work, but a semi-structured format is an alternative option when a tabular format becomes too rigid to describe the relationships between different entities.
The greatest strength of JSON also acts as its weakness—the data it contains informs the shape the object takes, rather than the other way around. Structured data is the bread and butter of analytics work, but a semi-structured format is an alternative option when a tabular format becomes too rigid to describe the relationships between different entities.
Binary file modified website/static/img/databricks_tutorial/images/choose_plan.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/img/databricks_tutorial/images/signup_form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1532a4d

Please sign in to comment.