Skip to content

Commit

Permalink
Clairy format required for specifiying roles (#4194)
Browse files Browse the repository at this point in the history
## What are you changing in this pull request and why?
<!---
The section is unclear to SEP users and SAs and had to be rewritten for
clarity.
-->

## Checklist
- [x] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
and [About
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
so my content adheres to these guidelines.
- [x] Needs technical review.
  • Loading branch information
amychen1776 authored Oct 9, 2023
2 parents 6f1a1a4 + 9c88c91 commit 132202e
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ The following profile fields are optional to set up. They let you configure your
| Profile field | Example | Description |
| ----------------------------- | -------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `threads` | `8` | How many threads dbt should use (default is `1`) |
| `roles` | `system: analyst` | Catalog roles |
| `roles` | `system: analyst` | Catalog roles can be set under the optional `roles` parameter using following format: `catalog: role`. |
| `session_properties` | `query_max_run_time: 4h` | Sets Trino session properties used in the connection. Execute `SHOW SESSION` to see available options |
| `prepared_statements_enabled` | `true` or `false` | Enable usage of Trino prepared statements (used in `dbt seed` commands) (default: `true`) |
| `retries` | `10` | Configure how many times all database operation is retried when connection issues arise (default: `3`) |
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
[comment: For context, the section title used for this snippet is "Roles in Starburst Enterprise" ]: #
[comment: For context, the section title used for this snippet is "Roles in Starburst Enterprise" ]: #

If connecting to a Starburst Enterprise cluster with built-in access controls enabled, you can't add the role as a suffix to the username, so the default role for the provided username is used instead.
If connecting to a Starburst Enterprise cluster with built-in access controls
enabled, you must specify a role using the format detailed in [Additional
parameters](#additional-parameters). If a role is not specified, the default
role for the provided username is used.

0 comments on commit 132202e

Please sign in to comment.