schemachange_snowflake_schema_migration_cli_programmatic_deploy.py

1import os
2from schemachange.cli import main
3
4# schemachange is primarily designed as a CLI tool, but can be invoked 
5# programmatically from Python. The following script demonstrates how 
6# to trigger a deployment using environment variables for configuration.
7
8# Set the necessary Snowflake connection parameters as environment variables
9os.environ["SNOWFLAKE_ACCOUNT"] = "your_account_identifier"
10os.environ["SNOWFLAKE_USER"] = "your_username"
11os.environ["SNOWFLAKE_PASSWORD"] = "your_password"
12os.environ["SNOWFLAKE_ROLE"] = "your_role"
13os.environ["SNOWFLAKE_WAREHOUSE"] = "your_warehouse"
14os.environ["SNOWFLAKE_DATABASE"] = "your_database"
15
16def run_schemachange():
17    # Define the arguments for the schemachange deploy command
18    # -f: The root folder containing your change scripts
19    # -a: The Snowflake account identifier
20    # -u: The Snowflake user
21    # -r: The Snowflake role
22    # -w: The Snowflake warehouse
23    # -d: The Snowflake database
24    args = [
25        "deploy",
26        "-f", "./migrations",
27        "-a", os.environ["SNOWFLAKE_ACCOUNT"],
28        "-u", os.environ["SNOWFLAKE_USER"],
29        "-r", os.environ["SNOWFLAKE_ROLE"],
30        "-w", os.environ["SNOWFLAKE_WAREHOUSE"],
31        "-d", os.environ["SNOWFLAKE_DATABASE"]
32    ]
33
34    # Execute the schemachange main function
35    try:
36        main(args)
37        print("Schema changes applied successfully.")
38    except Exception as e:
39        print(f"An error occurred during deployment: {e}")
40
41if __name__ == "__main__":
42    run_schemachange()