demo

Demo

The contents of this Demo serves two audiences - Consumers and Contributors. For the Consumer, the demo provides a basis to see how schemachange works with the main feature set. For the contributor, who forks the repo and submits PRs to the codebase, this will serve as a basis to test the PR against your own snowflake account to ensure your code change does not break any existing functionality.

Prequisite

• You will need your own snowflake Account to test the Demo - Both as a contributor and consumer.
• You will need to review and run statements in the provision folder or setup your own database and schema.
  • initialize.sql: Contains the SQL variables to initialize your environment.
  • 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 setup, 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 you snowflake account.
  • SNOWFLAKE_PASSWORD: This is the password for the user (SNOWFLAKE_USER) that will connect to the 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 setup for the demo. Default setup is SCHEMACHANGE_DEMO_WH
  • SNOWFLAKE_DATABASE Keyed to SCHEMACHANGE_DEMO
  • SNOWFLAKE_ROLE Keyed to SCHEMACHANGE_DEMO-DEPLOY

The scripts in the provision folder can be used to setup up your demo database along with a schema in that database that will house the change tracking tables needed to setup and teardown the schemas used to test a working version of the demo DDL scripts.

• The initialize script setups the database, warehouse and account level access roles that will be used on the
• The setup script creates the SCHEMACHANGE schema in the database that you created in the initialize step.

Setup

The setup scripts are included to build the schema needed by the GitHub Actions Workflow to avoid conflict across jobs when tested in parallel. The Setup script will create a new schema to run the schemachange script for the corresponding scenario.

Teardown

The Teardown scripts are the bookend pairing of the Setup script for each scenario so that when the build process is done using github actions, you will have a log of the testing done to ensure that schemachange is working as expected.