.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "App::Sqitch::Engine::snowflake 3pm" .TH App::Sqitch::Engine::snowflake 3pm "2019-02-15" "perl v5.28.1" "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" \fI\f(CI\*(C`uri\*(C'\fI\fR .IX Subsection "uri" .PP Returns the Snowflake database \s-1URI\s0 name. It starts with the \s-1URI\s0 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 \s-1URI.\s0 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. .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 , the \f(CW$SNOWSQL_REGION\fR or \f(CW\*(C`connections.region\*(C'\fR setting in the SnowSQL configuration file , and \f(CW\*(C`snowflakecomputing.com\*(C'\fR. .PP The port defaults to 443, but uses to the \f(CW$SNOWSQL_PORT\fR environment variable if it's set. The database name is determined by the following methods: .IP "1." 4 The path par t of the database \s-1URI.\s0 .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 . .IP "4." 4 If sqitch finds no value in the above places, it falls back on the system username. .PP Other attributes of the \s-1URI\s0 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 \fI\f(CI\*(C`account\*(C'\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 \s-1URI.\s0 .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 . .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 \s-1URI.\s0 .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 . .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 \s-1URI.\s0 .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 . .PP \fI\f(CI\*(C`warehouse\*(C'\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 \s-1URI\s0 .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 . .IP "4." 4 If none of the above are found, it falls back on the hard-coded value \&\*(L"sqitch\*(R". .PP \fI\f(CI\*(C`role\*(C'\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 \s-1URI\s0 .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 . .IP "4." 4 If none of the above are found, no role will be set. .SS "Instance Methods" .IX Subsection "Instance Methods" \fI\f(CI\*(C`initialized\*(C'\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 \fI\f(CI\*(C`initialize\*(C'\fI\fR .IX Subsection "initialize" .PP .Vb 1 \& $snowflake\->initialize; .Ve .PP Initializes a database for Sqitch by installing the Sqitch registry schema. .PP \fI\f(CI\*(C`snowsql\*(C'\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 .SH "License" .IX Header "License" Copyright (c) 2012\-2018 iovation Inc. .PP Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \*(L"Software\*(R"), 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 \&\s-1THE SOFTWARE IS PROVIDED \*(L"AS IS\*(R", 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.\s0