Welcome to the SuperClient dbt project.
- Learn more about dbt in the docs.
- Check out Discourse for commonly asked questions and answers.
- Join the community on Slack for live discussions and support.
- Find dbt events near you.
- Check out the blog for the latest news on dbt's development and best practices.
Visual Studio Code is the recommended text editor. Install from here.
Once installed, add the following extensions following this guide.
brew install git
Run the below commands to install pyenv, a Python version manager, and Python 3.8.
brew install pyenv
echo 'eval "$(pyenv init --path)"' >> ~/.zshrc
eval "$(pyenv init --path)"
pyenv install 3.8.13
pyenv global 3.8.13
Install Python 3.8, checking the 'Add Python to path' checkbox.
python -m pip install pipx
python -m pipx ensurepath
Close your command line and reopen before running
pipx install dbtenv-dbt-alias
Clone this repository to a folder on your computer, and navigate to it in your command line.
From within this repository, run
dbt init
and follow the prompts.
Your models will be built into the database analytics_dev under schemas prefixed with your name.
From inside the newly-cloned Git repository, run dbt deps to install all the packages specified in packages.yml.
To keep the code consistent please follow the dbt coding conventions and SQL style guide from Brooklyn Data Co.
We use Git to version control all of our work and peer review any new changes. A standard workflow is as follows:
- Checkout and pull the latest changes on main:
git checkout maingit pull origin main
- Create a new branch to work from:
git checkout -b <branch_name>
- Once you've made your changes, stage them with:
git add -A
- Commit your changes:
git commit -m 'Added X, Y and Z'
- Push your changes:
git push origin <branch_name>
- Open the link shown in the terminal under
Create a pull request..., and create a pull request to the main branch.
New dbt versions are announced in the Slack group, as well as on GitHub. It is recommended to keep up to date for new features and bug fixes. To upgrade, both local development and automated dbt jobs need to be updated. If on Mac and using brew, the command is:
brew upgrade dbt-snowflake
and on Windows the command is:
pipx upgrade dbt-snowflake
If you wish to have project-specific customizations in this project, you'll need to tell git not to recognize your changes so they don't get commited to the repo.
To do this, run the following command:
git update-index --skip-worktree .vscode/settings.json