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

adding dbt env command #4792

Merged
merged 9 commits into from
Jan 29, 2024
Merged

adding dbt env command #4792

merged 9 commits into from
Jan 29, 2024

Conversation

mirnawong1
Copy link
Contributor

@mirnawong1 mirnawong1 commented Jan 24, 2024

this pr adds the dbt environment command and its flags to the docs site for the cloud cli. it also sets it up so that may add more flags/commands if necessary.

it has been added in the following pages:

PR also renames the sidebar so the cloud cli is less repeated. add;l details provided here on the command and the next steps.

@mirnawong1 mirnawong1 requested a review from a team as a code owner January 24, 2024 21:15
Copy link

vercel bot commented Jan 24, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 29, 2024 10:41am

@github-actions github-actions bot added content Improvements or additions to content size: medium This change will take up to a week to address Docs team Authored by the Docs team @dbt Labs labels Jan 24, 2024

- Viewing your local configuration details (account ID, active project ID, deployment environment, and more).
- Viewing your dbt Cloud configuration details (account ID, environment ID, environment name, connection type, and more).
- CAN YOU MAKE CHANGES TO THE ENVIRONMENT?
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

flagging this question

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not currently, we plan to add this functionality at a later date. We shouldn't mention it yet.

Copy link
Contributor

@cesher cesher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Thank you!


- Viewing your local configuration details (account ID, active project ID, deployment environment, and more).
- Viewing your dbt Cloud configuration details (account ID, environment ID, environment name, connection type, and more).
- CAN YOU MAKE CHANGES TO THE ENVIRONMENT?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not currently, we plan to add this functionality at a later date. We shouldn't mention it yet.


The `dbt environment` command enables you to interact with your dbt Cloud environment. The `dbt environment` command is useful for:

- Viewing your local configuration details (account ID, active project ID, deployment environment, and more).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cesher one last question - what is the difference between local config and dbt cloud config in this context? i think i understand the difference in the 'git' context but wanted to clarify this for users.

is it:

  • local config -- details about their local environment setup?
  • cloud config - dbt cloud account and connection details

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

going to merge pr and address this when clarified in the shipped channel

- Viewing your local configuration details (account ID, active project ID, deployment environment, and more).
- Viewing your dbt Cloud configuration details (account ID, environment ID, environment name, connection type, and more).

This guide lists all the commands and options you can use with `dbt environment` in the [dbt Cloud CLI](/docs/cloud/cloud-cli-installation). To use it, add a command after it like this: `dbt environment [command]`.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i opted for plural here to make it easier for our future selves when more commands/options were added. adding

@mirnawong1 mirnawong1 enabled auto-merge January 29, 2024 10:32
@mirnawong1 mirnawong1 disabled auto-merge January 29, 2024 10:32
@mirnawong1 mirnawong1 enabled auto-merge January 29, 2024 10:37
@mirnawong1 mirnawong1 merged commit 0f982ff into current Jan 29, 2024
7 checks passed
@mirnawong1 mirnawong1 deleted the mwong-env-var-cmd branch January 29, 2024 10:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content Docs team Authored by the Docs team @dbt Labs January-2024 size: medium This change will take up to a week to address
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants