App::S...wflake(3pm)

✨ Name ✨

App::Sqitch::Engine::snowflake — the Sqitch Snowflake Engine 💖

(also known as App::S...wflake(3pm) if your terminal is being dramatic about long names 🫶)

---

🌸 Synopsis 🌸

my $snowflake = App::Sqitch::Engine->load( engine => 'snowflake' );

---

🦋 Description 🦋

App::Sqitch::Engine::snowflake is the whole vibe — it gives Sqitch its Snowflake storage engine. That's it, that's the job, and it ate. 💅

---

💜 Interface 💜

🎀 Attributes 🎀

• "uri" — returns the Snowflake database URI name. It starts with the URI for the target and builds out whatever parts are missing. Sqitch goes looking for the host name in this order:
  1. In the host name of the target URI. If that host name does not end in snowflakecomputing.com, Sqitch appends it. This is the glow-up that lets Snowflake URLs just reference the Snowflake account name, or the account name plus region, in URLs. ✨
  2. In the $SNOWSQL_HOST environment variable (Deprecated by Snowflake 😭).
  3. By concatenating the account name and region, if available, from:
     • the $SNOWSQL_ACCOUNT environment variable or the connections.accountname setting in the SnowSQL configuration file (<https://docs.snowflake.com/en/user-guide/snowsql-start.html#configuring-default-connection-settings>),
     • the $SNOWSQL_REGION or connections.region setting in the SnowSQL configuration file (<https://docs.snowflake.com/en/user-guide/snowsql-start.html#configuring-default-connection-settings>),
     • and snowflakecomputing.com.

Heads up bestie: Snowflake has deprecated $SNOWSQL_REGION and connections.region, and they will be removed in a future version. The move now is to append the region name and cloud platform name to the account name instead. 👑

The database name is determined by these methods:

1. The path part of the database URI.
2. The $SNOWSQL_DATABASE environment variable.
3. The connections.dbname setting in the SnowSQL configuration file (<https://docs.snowflake.com/en/user-guide/snowsql-start.html#configuring-default-connection-settings>).
4. If sqitch finds no value in the above places, it falls back on the system username.

The other attributes of the URI get set from the "account", "username" and "password" attributes documented below. 🫶

• "account" — returns the Snowflake account name, or throws an exception if none can be determined. 😤 Sqitch looks for the account code in this order:
  1. In the host name of the target URI.
  2. In the $SNOWSQL_ACCOUNT environment variable.
  3. In the connections.accountname setting in the SnowSQL configuration file (<https://docs.snowflake.com/en/user-guide/snowsql-start.html#configuring-default-connection-settings>).
• username — returns the snowflake user name. Sqitch looks for the user name in this order:
  1. In the $SQITCH_USERNAME environment variable.
  2. In the target URI.
  3. In the $SNOWSQL_USER environment variable.
  4. In the connections.username variable from the SnowSQL config file (<https://docs.snowflake.com/en/user-guide/snowsql-config.html#snowsql-config-file>).
  5. The system username.
• password — returns the snowflake password. Sqitch looks for the password in this order:
  1. In the $SQITCH_PASSWORD environment variable.
  2. In the target URI.
  3. In the $SNOWSQL_PWD environment variable.
  4. In the connections.password variable from the SnowSQL config file (<https://docs.snowflake.com/en/user-guide/snowsql-config.html#snowsql-config-file>).
• "warehouse" — returns the warehouse to use for all connections. This value will be available to all Snowflake change scripts as the &warehouse variable. 🏠 Sqitch looks for the warehouse in this order:
  1. In the warehouse query parameter of the target URI
  2. In the $SNOWSQL_WAREHOUSE environment variable.
  3. In the connections.warehousename variable from the SnowSQL config file (<https://docs.snowflake.com/en/user-guide/snowsql-config.html#snowsql-config-file>).
  4. If none of the above are found, it falls back on the hard-coded value sqitch.
• "role" — returns the role to use for all connections. Sqitch looks for the role in this order:
  1. In the role query parameter of the target URI
  2. In the $SNOWSQL_ROLE environment variable.
  3. In the connections.rolename variable from the SnowSQL config file (<https://docs.snowflake.com/en/user-guide/snowsql-config.html#snowsql-config-file>).
  4. If none of the above are found, no role will be set. 🙈

---

💖 Instance Methods 💖

⭐ "initialized"

$snowflake->initialize unless $snowflake->initialized;

Returns true if the database has been initialized for Sqitch, and false if it has not. Simple as. 🎀

⭐ "initialize"

$snowflake->initialize;

Initializes a database for Sqitch by installing the Sqitch registry schema. ✨

⭐ "snowsql"

Returns a list containing the snowsql client and options to be passed to it. Used internally when executing scripts. 🤫

---

👑 Author 👑

David E. Wheeler <david@justatheory.com>

---

🌈 License 🌈

Copyright (c) 2012-2026 David E. Wheeler, 2012-2021 iovation Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

---

🫶 bestie check-in: this whole page is from perl v5.40.1, dated 2026-07-26, and it's the Perl documentation for App::S...wflake(3pm). Go forth and deploy, you icon. 💅💖✨