Skip to content

Commit

Permalink
Merge branch 'current' into test-sl-ia
Browse files Browse the repository at this point in the history
  • Loading branch information
mirnawong1 authored Jan 6, 2025
2 parents e45a5bb + 4875f4b commit a8c5580
Show file tree
Hide file tree
Showing 8 changed files with 78 additions and 17 deletions.
2 changes: 1 addition & 1 deletion website/docs/docs/build/incremental-microbatch.md
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ models:
incremental_strategy='microbatch',
event_time='session_start',
begin='2020-01-01',
batch_size='day
batch_size='day',
concurrent_batches=true, # value set to true to run batches in parallel
...
)
Expand Down
26 changes: 17 additions & 9 deletions website/docs/docs/cloud/manage-access/about-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@ pagination_prev: null

:::info "User access" is not "Model access"

This page is specific to user groups and access, which includes:
This page covers user groups and access, including:
- User licenses, permissions, and group memberships
- Role-based access controls for projects and environments
- Single sign-on and secure authentication
- Single sign-on, and secure authentication

"Model groups and access" is a feature specific to models and their availability across projects. Refer to [Model access](/docs/collaborate/govern/model-access) for more info on what it means for your dbt projects.
For model-specific access and their availability across projects, refer to [Model access](/docs/collaborate/govern/model-access).

:::

# About user access

You can regulate access to dbt Cloud by various measures, including licenses, groups, permissions, and role-based access control (RBAC). To understand the possible approaches to user access to dbt Cloud features and functionality, you should first know how we approach users and groups.

### Users
## Users

Individual users in dbt Cloud can be people you [manually invite](/docs/cloud/manage-access/invite-users) or grant access via an external identity provider (IdP), such as Microsoft Entra ID, Okta, or Google Workspace.

Expand All @@ -33,10 +33,15 @@ You can edit an existing user's license by navigating to the **Users** section o

<Lightbox src="/img/docs/dbt-cloud/dbt-cloud-enterprise/access-control/edit-user.png" width="60%" title="Example of the user information window in the user directory" />

## Groups

### Groups
Groups in dbt Cloud serve much of the same purpose as they do in traditional directory tools &mdash; to gather individual users together to make bulk assignments of permissions easier.

Groups in dbt Cloud serve much of the same purpose as they do in traditional directory tools &mdash; to gather individual users together to make bulk assignment of permissions easier. Admins use groups in dbt Cloud to assign [licenses](#licenses) and [permissions](#permissions). The permissions are more granular than licenses, and you only assign them at the group level; _you can’t assign permissions at the user level._ Every user in dbt Cloud must be assigned to at least one group.
The permissions available depends on whether you're on an [Enterprise](/docs/cloud/manage-access/enterprise-permissions) or [self-service Team](/docs/cloud/manage-access/self-service-permissions) plan.

- Admins use groups in dbt Cloud to assign [licenses](#licenses) and [permissions](#permissions).
- The permissions are more granular than licenses, and you only assign them at the group level; _you can’t assign permissions at the user level._
- Every user in dbt Cloud must be assigned to at least one group.

There are three default groups available as soon as you create your dbt Cloud account (the person who created the account is added to all three automatically):

Expand All @@ -46,7 +51,10 @@ There are three default groups available as soon as you create your dbt Cloud ac

We recommend deleting the default `Owner`, `Member`, and `Everyone` groups before deploying and replacing them with your organizational groups. This prevents users from receiving more elevated privileges than they should and helps admins ensure they are properly placed.

Create new groups from the **Groups & Licenses** section of the **Account settings**. If you use an external IdP for SSO, you can sync those SSO groups to dbt Cloud from the **Group details** pane when creating or editing existing groups.
### Create new groups <Lifecycle status='enterprise'/>

- Create new groups from the **Groups & Licenses** section of the **Account settings**.
- If you use an external IdP for SSO, you can sync those SSO groups to dbt Cloud from the **Group details** pane when creating or editing existing groups.

<Lightbox src="/img/docs/dbt-cloud/dbt-cloud-enterprise/access-control/new-group.png" width="60%" title="Example the new group pane in the account settings." />

Expand All @@ -56,7 +64,7 @@ If a user is assigned licenses and permissions from multiple groups, the group t

:::

#### SSO mappings
### SSO mappings <Lifecycle status='enterprise'/>

SSO Mappings connect an identity provider (IdP) group membership to a dbt Cloud group. When users log into dbt Cloud via a supported identity provider, their IdP group memberships sync with dbt Cloud. Upon logging in successfully, the user's group memberships (and permissions) will automatically adjust within dbt Cloud.

Expand Down Expand Up @@ -215,4 +223,4 @@ Each dbt Cloud plan has a base number of Developer and Read-Only licenses. You c

For detailed steps, refer to [Users and licenses](/docs/cloud/manage-access/seats-and-users#licenses).

</Expandable>
</Expandable>
Original file line number Diff line number Diff line change
Expand Up @@ -39,16 +39,27 @@ jaffle_shop:
dbname: jaffle_shop
schema: dbt_alice
threads: 4

prod: # additional prod target
type: postgres
host: prod.db.example.com
user: alice
password: <prod_password>
port: 5432
dbname: jaffle_shop
schema: analytics
threads: 8
```
</File>
To add an additional target (like `prod`) to your existing `profiles.yml`, you can add another entry under the `outputs` key.

## About the `profiles.yml` file

In your `profiles.yml` file, you can store as many profiles as you need. Typically, you would have one profile for each warehouse you use. Most organizations only have one profile.
In your `profiles.yml` file, you can store as many profiles as you need. Typically, you would have one profile for each warehouse you use. Most organizations only have one profile.

For information about configuring advanced options, see [the `profiles.yml` reference page](/docs/core/connect-data-platform/profiles.yml).
or information about configuring advanced options, see [the `profiles.yml` reference page](/docs/core/connect-data-platform/profiles.yml).

## About profiles

Expand Down
2 changes: 2 additions & 0 deletions website/docs/docs/core/connect-data-platform/profiles.yml.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ If you're using dbt Cloud, you can [connect to your data platform](/docs/cloud/c

This section identifies the parts of your `profiles.yml` that aren't specific to a particular data platform. For specific connection details, refer to the relevant page for your data platform.

To add an additional target (like `prod`) to your existing `profiles.yml`, you can add another entry under the `outputs` key.

<VersionBlock lastVersion="1.7">

:::warning Global configs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,11 @@ dbt Core v1.5 introduced model governance which we're continuing to refine. v1.
- **[Breaking change detection](/reference/resource-properties/versions#detecting-breaking-changes) for models with contracts enforced:** When dbt detects a breaking change to a model with an enforced contract during state comparison, it will now raise an error for versioned models and a warning for models that are not versioned.
- **[Set `access` as a config](/reference/resource-configs/access):** You can now set a model's `access` within config blocks in the model's file or in the `dbt_project.yml` for an entire subfolder at once.
- **[Type aliasing for model contracts](/reference/resource-configs/contract):** dbt will use each adapter's built-in type aliasing for user-provided data types—meaning you can now write `string` always, and dbt will translate to `text` on Postgres/Redshift. This is "on" by default, but you can opt-out.
- **[Raise warning for numeric types](/reference/resource-configs/contract):** Because of issues when putting `numeric` in model contracts without considering that default values such as `numeric(38,0)` might round decimals accordingly. dbt will now warn you if it finds a numeric type without specified precision/scale.
- **[Raise warning for numeric types](/reference/resource-configs/contract):** Because of issues when putting `numeric` in model contracts without considering that default values such as `numeric(38,0)` might round decimals accordingly. dbt will now warn you if it finds a numeric type without specified precision/scale.

### dbt clean

Starting in v1.7, `dbt clean` will only clean paths within the current working directory. The `--no-clean-project-files-only` flag will delete all paths specified in the `clean-targets` section of `dbt_project.yml`, even if they're outside the dbt project.
Starting in v1.7, [dbt clean](/reference/commands/clean) will only clean paths within the current working directory. The `--no-clean-project-files-only` flag will delete all paths specified in the `clean-targets` section of `dbt_project.yml`, even if they're outside the dbt project.

Supported flags:
- `--clean-project-files-only` (default)
Expand Down
41 changes: 40 additions & 1 deletion website/docs/reference/commands/clean.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,45 @@ sidebar_label: "clean"
id: "clean"
---

`dbt clean` is a utility function that deletes all folders specified in the [`clean-targets`](/reference/project-configs/clean-targets) list specified in `dbt_project.yml`. You can use this to delete the `dbt_packages` and `target` directories.
`dbt clean` is a utility function that deletes the paths specified within the [`clean-targets`](/reference/project-configs/clean-targets) list in the `dbt_project.yml` file. It helps by removing unnecessary files or directories generated during the execution of other dbt commands, ensuring a clean state for the project.

## Example usage
```
dbt clean
```

## Supported flags

This section will briefly explain the following flags:

- [`--clean-project-files-only`](#--clean-project-files-only) (default)
- [`--no-clean-project-files-only`](#--no-clean-project-files-only)

To view the list of all supported flags for the `dbt clean` command in the terminal, use the `--help` flag, which will display detailed information about the available flags you can use, including its description and usage:

```shell
dbt clean --help
```

### --clean-project-files-only
By default, dbt deletes all the paths within the project directory specified in `clean-targets`.

:::note
Avoid using paths outside the dbt project; otherwise, you will see an error.
:::


#### Example usage
```shell
dbt clean --clean-project-files-only
```

### --no-clean-project-files-only
Deletes all the paths specified in the `clean-targets` list of `dbt_project.yml`, including those outside the current dbt project.

```shell
dbt clean --no-clean-project-files-only
```

## dbt clean with remote file system
To avoid complex permissions issues and potentially deleting crucial aspects of the remote file system without access to fix them, this command does not work when interfacing with the RPC server that powers the dbt Cloud IDE. Instead, when working in dbt Cloud, the `dbt deps` command cleans before it installs packages automatically. The `target` folder can be manually deleted from the sidebar file tree if needed.
2 changes: 1 addition & 1 deletion website/docs/reference/commands/run-operation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ id: "run-operation"

### Overview

The `dbt run-operation` command is used to invoke a macro. For usage information, consult the docs on [operations](/docs/build/hooks-operations#operations).
The `dbt run-operation` command is used to invoke a macro. For usage information, consult the docs on [operations](/docs/build/hooks-operations#about-operations).

### Usage
```
Expand Down
3 changes: 2 additions & 1 deletion website/docs/reference/resource-configs/batch_size.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@ Example in sql model config block:
```sql
{{ config(
lookback='day
materialized='incremental',
batch_size='day'
) }}
```

Expand Down

0 comments on commit a8c5580

Please sign in to comment.