.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "App::Sqitch::Engine::snowflake 3pm"
.TH App::Sqitch::Engine::snowflake 3pm 2024-02-08 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH Name
.IX Header "Name"
App::Sqitch::Engine::snowflake \- Sqitch Snowflake Engine
.SH Synopsis
.IX Header "Synopsis"
.Vb 1
\&  my $snowflake = App::Sqitch::Engine\->load( engine => \*(Aqsnowflake\*(Aq );
.Ve
.SH Description
.IX Header "Description"
App::Sqitch::Engine::snowflake provides the Snowflake storage engine for Sqitch.
.SH Interface
.IX Header "Interface"
.SS Attributes
.IX Subsection "Attributes"
\fR\f(CI\*(C`uri\*(C'\fR\fI\fR
.IX Subsection "uri"
.PP
Returns the Snowflake database URI name. It starts with the URI for the target
and builds out missing parts. Sqitch looks for the host name in this order:
.IP 1. 4
In the host name of the target URI. If that host name does not end in
\&\f(CW\*(C`snowflakecomputing.com\*(C'\fR, Sqitch appends it. This lets Snowflake URLs just
reference the Snowflake account name or the account name and region in URLs.
.IP 2. 4
In the \f(CW$SNOWSQL_HOST\fR environment variable (Deprecated by Snowflake).
.IP 3. 4
By concatenating the account name and region, if available, from the
\&\f(CW$SNOWSQL_ACCOUNT\fR environment variable or \f(CW\*(C`connections.accountname\*(C'\fR setting
in the
SnowSQL configuration file <https://docs.snowflake.com/en/user-guide/snowsql-start.html#configuring-default-connection-settings>,
the \f(CW$SNOWSQL_REGION\fR or \f(CW\*(C`connections.region\*(C'\fR setting in the
SnowSQL configuration file <https://docs.snowflake.com/en/user-guide/snowsql-start.html#configuring-default-connection-settings>,
and \f(CW\*(C`snowflakecomputing.com\*(C'\fR. Note that Snowflake has deprecated
\&\f(CW$SNOWSQL_REGION\fR and \f(CW\*(C`connections.region\*(C'\fR, and will be removed in a future
version. Append the region name and cloud platform name to the account name,
instead.
.PP
The database name is determined by the following methods:
.IP 1. 4
The path par t of the database URI.
.IP 2. 4
The \f(CW$SNOWSQL_DATABASE\fR environment variable.
.IP 3. 4
In the \f(CW\*(C`connections.dbname\*(C'\fR setting in the
SnowSQL configuration file <https://docs.snowflake.com/en/user-guide/snowsql-start.html#configuring-default-connection-settings>.
.IP 4. 4
If sqitch finds no value in the above places, it falls back on the system
username.
.PP
Other attributes of the URI are set from the \f(CW\*(C`account\*(C'\fR, \f(CW\*(C`username\*(C'\fR and
\&\f(CW\*(C`password\*(C'\fR attributes documented below.
.PP
\fR\f(CI\*(C`account\*(C'\fR\fI\fR
.IX Subsection "account"
.PP
Returns the Snowflake account name, or an exception if none can be determined.
Sqitch looks for the account code in this order:
.IP 1. 4
In the host name of the target URI.
.IP 2. 4
In the \f(CW$SNOWSQL_ACCOUNT\fR environment variable.
.IP 3. 4
In the \f(CW\*(C`connections.accountname\*(C'\fR setting in the
SnowSQL configuration file <https://docs.snowflake.com/en/user-guide/snowsql-start.html#configuring-default-connection-settings>.
.PP
\fIusername\fR
.IX Subsection "username"
.PP
Returns the snowflake user name. Sqitch looks for the user name in this order:
.IP 1. 4
In the \f(CW$SQITCH_USERNAME\fR environment variable.
.IP 2. 4
In the target URI.
.IP 3. 4
In the \f(CW$SNOWSQL_USER\fR environment variable.
.IP 4. 4
In the \f(CW\*(C`connections.username\*(C'\fR variable from the
SnowSQL config file <https://docs.snowflake.com/en/user-guide/snowsql-config.html#snowsql-config-file>.
.IP 5. 4
The system username.
.PP
\fIpassword\fR
.IX Subsection "password"
.PP
Returns the snowflake password. Sqitch looks for the password in this order:
.IP 1. 4
In the \f(CW$SQITCH_PASSWORD\fR environment variable.
.IP 2. 4
In the target URI.
.IP 3. 4
In the \f(CW$SNOWSQL_PWD\fR environment variable.
.IP 4. 4
In the \f(CW\*(C`connections.password\*(C'\fR variable from the
SnowSQL config file <https://docs.snowflake.com/en/user-guide/snowsql-config.html#snowsql-config-file>.
.PP
\fR\f(CI\*(C`warehouse\*(C'\fR\fI\fR
.IX Subsection "warehouse"
.PP
Returns the warehouse to use for all connections. This value will be available
to all Snowflake change scripts as the \f(CW&warehouse\fR variable. Sqitch looks
for the warehouse in this order:
.IP 1. 4
In the \f(CW\*(C`warehouse\*(C'\fR query parameter of the target URI
.IP 2. 4
In the \f(CW$SNOWSQL_WAREHOUSE\fR environment variable.
.IP 3. 4
In the \f(CW\*(C`connections.warehousename\*(C'\fR variable from the
SnowSQL config file <https://docs.snowflake.com/en/user-guide/snowsql-config.html#snowsql-config-file>.
.IP 4. 4
If none of the above are found, it falls back on the hard-coded value
"sqitch".
.PP
\fR\f(CI\*(C`role\*(C'\fR\fI\fR
.IX Subsection "role"
.PP
Returns the role to use for all connections. Sqitch looks for the role in this
order:
.IP 1. 4
In the \f(CW\*(C`role\*(C'\fR query parameter of the target URI
.IP 2. 4
In the \f(CW$SNOWSQL_ROLE\fR environment variable.
.IP 3. 4
In the \f(CW\*(C`connections.rolename\*(C'\fR variable from the
SnowSQL config file <https://docs.snowflake.com/en/user-guide/snowsql-config.html#snowsql-config-file>.
.IP 4. 4
If none of the above are found, no role will be set.
.SS "Instance Methods"
.IX Subsection "Instance Methods"
\fR\f(CI\*(C`initialized\*(C'\fR\fI\fR
.IX Subsection "initialized"
.PP
.Vb 1
\&  $snowflake\->initialize unless $snowflake\->initialized;
.Ve
.PP
Returns true if the database has been initialized for Sqitch, and false if it
has not.
.PP
\fR\f(CI\*(C`initialize\*(C'\fR\fI\fR
.IX Subsection "initialize"
.PP
.Vb 1
\&  $snowflake\->initialize;
.Ve
.PP
Initializes a database for Sqitch by installing the Sqitch registry schema.
.PP
\fR\f(CI\*(C`snowsql\*(C'\fR\fI\fR
.IX Subsection "snowsql"
.PP
Returns a list containing the \f(CW\*(C`snowsql\*(C'\fR client and options to be passed to
it. Used internally when executing scripts.
.SH Author
.IX Header "Author"
David E. Wheeler <david@justatheory.com>
.SH License
.IX Header "License"
Copyright (c) 2012\-2024 iovation Inc., David E. Wheeler
.PP
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:
.PP
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
.PP
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.