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

feat: deprecate verbose flag #2

Open
wants to merge 26 commits into
base: feature/flag-for-error-on-ignored-versioned-migration
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
b5ba046
Merge pull request #285 from zanebclark/feature/code-reorganization
jamesweakley Oct 7, 2024
b6a80a1
feat: deprecate verbose flag
Sep 26, 2024
9be9e01
Update README.md
mattgrcia Sep 4, 2024
fc0d0f1
fix: remove kw_only argument introduced in 3.10
Oct 18, 2024
6b1c1b3
fix: standardize "" and None alphanum_key behavior
Oct 18, 2024
5630bca
Merge pull request #294 from zanebclark/fix/kw_only_get_alphanum_key_…
sfc-gh-tmathew Oct 25, 2024
e947e42
Updating Ownership hierarchy to allow schemachange to create the sche…
sfc-gh-tmathew Oct 25, 2024
8d15e52
fixing syntax issue
sfc-gh-tmathew Oct 25, 2024
2537bb9
checking the default schema creation step
sfc-gh-tmathew Oct 25, 2024
fc480ae
adding missing schema reference in demo script
sfc-gh-tmathew Oct 25, 2024
1a2f1e7
Added create schema privilege to deploy role because schemachange tri…
sfc-gh-tmathew Oct 25, 2024
4a261ec
Restore the schema reference in demo config
sfc-gh-tmathew Oct 25, 2024
e141821
Merge pull request #297 from Snowflake-Labs/Fix_Demo_workflow
sfc-gh-tmathew Oct 25, 2024
53f893a
Merge pull request #299 from Snowflake-Labs/release/v4.0.0
sfc-gh-tmathew Oct 29, 2024
1a7ed11
Changes
sfc-gh-tmathew Oct 29, 2024
b1ca32d
Merge branch 'master' into update_contributing_guidelines
sfc-gh-tmathew Oct 29, 2024
8004ed9
Update .github/CONTRIBUTING.md
sfc-gh-tmathew Oct 29, 2024
402cb2b
Update demo/README.MD
sfc-gh-tmathew Oct 29, 2024
73cbe88
Update demo/README.MD
sfc-gh-tmathew Oct 29, 2024
6314ce4
Update demo/README.MD
sfc-gh-tmathew Oct 29, 2024
bf08a2a
Update demo/README.MD
sfc-gh-tmathew Oct 29, 2024
2c553e8
Implementing review changes
sfc-gh-tmathew Oct 29, 2024
11bdee7
Implementing review comments
sfc-gh-tmathew Oct 29, 2024
871d7c7
Merge pull request #300 from Snowflake-Labs/update_contributing_guide…
sfc-gh-tmathew Oct 30, 2024
9985201
Merge branch 'master' into feature/deprecate-verbose-flag
Nov 18, 2024
5695cc2
feat: set a default for log level
Nov 18, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Implementing review comments
  • Loading branch information
sfc-gh-tmathew committed Oct 29, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
commit 11bdee7420ff60dbf611c6b7ce0624c53bfb6aba
37 changes: 20 additions & 17 deletions demo/README.MD
Original file line number Diff line number Diff line change
@@ -13,32 +13,24 @@ not break any existing functionality.
- [setup_schemachange_schema.sql](provision/setup_schemachange_schema.sql): Contains the SQL variables to track the
individual demo scenarios in its own change history table.

### Contributors

As a contributor, you will have to set up schemachange demo database and schemachange schema (See Initialize and Setup
scripts below). Along with that you will also set up the following Secrets in your forked repository so that the GitHub
actions can set up, test and teardown the temporary schema it creates to test the changes to your code in the master and
dev branches respectively.

- SCHEMACHANGE_SNOWFLAKE_PASSWORD
- SCHEMACHANGE_SNOWFLAKE_USER
- SCHEMACHANGE_SNOWFLAKE_ACCOUNT

### Consumers

- If you are consumer who is installing schemachange and wants to test-run the demo, then you will have to set the
following environment variables.
- SNOWFLAKE_ACCOUNT: This will be the account identifier for your Snowflake account.
- SNOWFLAKE_USER: This will be the user that will connect to your Snowflake account (`SNOWFLAKE_ACCOUNT`).
- SNOWFLAKE_PASSWORD: This is the password for the user (`SNOWFLAKE_USER`) that will connect to your Snowflake account (`SNOWFLAKE_ACCOUNT`).
- SNOWFLAKE_PASSWORD: This is the password for the user (`SNOWFLAKE_USER`) that will connect to your Snowflake
account (`SNOWFLAKE_ACCOUNT`).
- SCENARIO_NAME: This will be demo folder you intend to experiment with. For
starters, `basics_demo`, `citibike_demo` or `citibike_demo_jinja` are included with the repo that will set the
root folder value in the respective schemachange-config.yml file.
- SNOWFLAKE_WAREHOUSE: This will be the warehouse you set up for the demo. Default setup is SCHEMACHANGE_DEMO_WH. You can update this to your warehouse in your Snowflake account (`SNOWFLAKE_ACCOUNT`).
- SNOWFLAKE_DATABASE Keyed to SCHEMACHANGE_DEMO. You can update this to the database in your snowflake account (`SNOWFLAKE_ACCOUNT`)
- SNOWFLAKE_ROLE Keyed to SCHEMACHANGE_DEMO-DEPLOY. This particular role name was chosen to test hyphenated roles in schemachange. You can update this value to match the role you have setup in your snowflake account (`SNOWFLAKE_ACCOUNT`).

Either you setup Warehouse, Database and role to match the demo defaults and run the demo as is pointing to your account (`SNOWFLAKE_ACCOUNT`) or update the schemachange-config.yml file keys to match values you have setup in your local snowflake account and run the demo scenarios to get a feel for how schemachange works.
- SNOWFLAKE_WAREHOUSE: This will be the warehouse you set up for the demo in your Snowflake
account (`SNOWFLAKE_ACCOUNT`). Default setup is SCHEMACHANGE_DEMO_WH.
- SNOWFLAKE_DATABASE Keyed to SCHEMACHANGE_DEMO. You can update this to the database in your snowflake account
(`SNOWFLAKE_ACCOUNT`). You will also need to update the provision scripts accordingly.
- SNOWFLAKE_ROLE Keyed to SCHEMACHANGE_DEMO-DEPLOY. This particular role name was chosen to test hyphenated roles
in schemachange. You can update this value to match the role you have setup in your snowflake
account (`SNOWFLAKE_ACCOUNT`).

The scripts in the `provision` folder can be used to set up up your demo database along with a schema in that database
that will house the change tracking tables needed to set up and teardown the schemas used to test a working version of
@@ -49,6 +41,17 @@ the demo DDL scripts.
- The [setup](provision/setup_schemachange_schema.sql) script creates the `SCHEMACHANGE` schema in the database that you
created in the initialize step.

### Contributors

As a contributor, you will have to set up schemachange demo database and schemachange schema (See Initialize and Setup
scripts below). Along with that you will also set up the following Secrets in your forked repository so that the GitHub
actions can set up, test and teardown the temporary schema it creates to test the changes to your code in the master and
dev branches respectively.

- SCHEMACHANGE_SNOWFLAKE_PASSWORD
- SCHEMACHANGE_SNOWFLAKE_USER
- SCHEMACHANGE_SNOWFLAKE_ACCOUNT

# Setup

The setup scripts are included to build the schema needed by the GitHub Actions Workflow to avoid conflict across jobs