pulumi-snowflake 2.5.0a1756363446__py3-none-any.whl → 2.5.0a1756524553__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of pulumi-snowflake might be problematic. Click here for more details.

Files changed (12) hide show
  1. pulumi_snowflake/config/__init__.pyi +36 -84
  2. pulumi_snowflake/config/vars.py +36 -84
  3. pulumi_snowflake/database.py +8 -0
  4. pulumi_snowflake/failover_group.py +7 -7
  5. pulumi_snowflake/provider.py +130 -304
  6. pulumi_snowflake/pulumi-plugin.json +1 -1
  7. pulumi_snowflake/schema.py +8 -0
  8. pulumi_snowflake/secondary_database.py +8 -0
  9. {pulumi_snowflake-2.5.0a1756363446.dist-info → pulumi_snowflake-2.5.0a1756524553.dist-info}/METADATA +1 -1
  10. {pulumi_snowflake-2.5.0a1756363446.dist-info → pulumi_snowflake-2.5.0a1756524553.dist-info}/RECORD +12 -12
  11. {pulumi_snowflake-2.5.0a1756363446.dist-info → pulumi_snowflake-2.5.0a1756524553.dist-info}/WHEEL +0 -0
  12. {pulumi_snowflake-2.5.0a1756363446.dist-info → pulumi_snowflake-2.5.0a1756524553.dist-info}/top_level.txt +0 -0
pulumi_snowflake/config/__init__.pyi CHANGED
@@ -17,17 +17,12 @@ from . import outputs
17
17
 
18
18
  accountName: Optional[str]
19
19
  """
20
- Specifies your Snowflake account name assigned by Snowflake. For information about account identifiers, see the
21
- [Snowflake documentation](https://docs.snowflake.com/en/user-guide/admin-account-identifier#account-name). Required
22
- unless using `profile`. Can also be sourced from the `SNOWFLAKE_ACCOUNT_NAME` environment variable.
20
+ Specifies your Snowflake account name assigned by Snowflake. For information about account identifiers, see the [Snowflake documentation](https://docs.snowflake.com/en/user-guide/admin-account-identifier#account-name). Required unless using `profile`. Can also be sourced from the `SNOWFLAKE_ACCOUNT_NAME` environment variable.
23
21
  """
24
22
 
25
23
  authenticator: Optional[str]
26
24
  """
27
- Specifies the [authentication type](https://pkg.go.dev/github.com/snowflakedb/gosnowflake#AuthType) to use when
28
- connecting to Snowflake. Valid options are: `SNOWFLAKE` | `OAUTH` | `EXTERNALBROWSER` | `OKTA` | `SNOWFLAKE_JWT` |
29
- `TOKENACCESSOR` | `USERNAMEPASSWORDMFA` | `PROGRAMMATIC_ACCESS_TOKEN`. Can also be sourced from the
30
- `SNOWFLAKE_AUTHENTICATOR` environment variable.
25
+ Specifies the [authentication type](https://pkg.go.dev/github.com/snowflakedb/gosnowflake#AuthType) to use when connecting to Snowflake. Valid options are: `SNOWFLAKE` | `OAUTH` | `EXTERNALBROWSER` | `OKTA` | `SNOWFLAKE_JWT` | `TOKENACCESSOR` | `USERNAMEPASSWORDMFA` | `PROGRAMMATIC_ACCESS_TOKEN`. Can also be sourced from the `SNOWFLAKE_AUTHENTICATOR` environment variable.
31
26
  """
32
27
 
33
28
  clientIp: Optional[str]
@@ -37,32 +32,27 @@ IP address for network checks. Can also be sourced from the `SNOWFLAKE_CLIENT_IP
37
32
 
38
33
  clientRequestMfaToken: Optional[str]
39
34
  """
40
- When true the MFA token is cached in the credential manager. True by default in Windows/OSX. False for Linux. Can also
41
- be sourced from the `SNOWFLAKE_CLIENT_REQUEST_MFA_TOKEN` environment variable.
35
+ When true the MFA token is cached in the credential manager. True by default in Windows/OSX. False for Linux. Can also be sourced from the `SNOWFLAKE_CLIENT_REQUEST_MFA_TOKEN` environment variable.
42
36
  """
43
37
 
44
38
  clientStoreTemporaryCredential: Optional[str]
45
39
  """
46
- When true the ID token is cached in the credential manager. True by default in Windows/OSX. False for Linux. Can also be
47
- sourced from the `SNOWFLAKE_CLIENT_STORE_TEMPORARY_CREDENTIAL` environment variable.
40
+ When true the ID token is cached in the credential manager. True by default in Windows/OSX. False for Linux. Can also be sourced from the `SNOWFLAKE_CLIENT_STORE_TEMPORARY_CREDENTIAL` environment variable.
48
41
  """
49
42
 
50
43
  clientTimeout: Optional[int]
51
44
  """
52
- The timeout in seconds for the client to complete the authentication. Can also be sourced from the
53
- `SNOWFLAKE_CLIENT_TIMEOUT` environment variable.
45
+ The timeout in seconds for the client to complete the authentication. Can also be sourced from the `SNOWFLAKE_CLIENT_TIMEOUT` environment variable.
54
46
  """
55
47
 
56
48
  disableConsoleLogin: Optional[str]
57
49
  """
58
- Indicates whether console login should be disabled in the driver. Can also be sourced from the
59
- `SNOWFLAKE_DISABLE_CONSOLE_LOGIN` environment variable.
50
+ Indicates whether console login should be disabled in the driver. Can also be sourced from the `SNOWFLAKE_DISABLE_CONSOLE_LOGIN` environment variable.
60
51
  """
61
52
 
62
53
  disableQueryContextCache: Optional[bool]
63
54
  """
64
- Disables HTAP query context cache in the driver. Can also be sourced from the `SNOWFLAKE_DISABLE_QUERY_CONTEXT_CACHE`
65
- environment variable.
55
+ Disables HTAP query context cache in the driver. Can also be sourced from the `SNOWFLAKE_DISABLE_QUERY_CONTEXT_CACHE` environment variable.
66
56
  """
67
57
 
68
58
  disableTelemetry: Optional[bool]
@@ -72,39 +62,32 @@ Disables telemetry in the driver. Can also be sourced from the `DISABLE_TELEMETR
72
62
 
73
63
  driverTracing: Optional[str]
74
64
  """
75
- Specifies the logging level to be used by the driver. Valid options are: `trace` | `debug` | `info` | `print` |
76
- `warning` | `error` | `fatal` | `panic`. Can also be sourced from the `SNOWFLAKE_DRIVER_TRACING` environment variable.
65
+ Specifies the logging level to be used by the driver. Valid options are: `trace` | `debug` | `info` | `print` | `warning` | `error` | `fatal` | `panic`. Can also be sourced from the `SNOWFLAKE_DRIVER_TRACING` environment variable.
77
66
  """
78
67
 
79
68
  externalBrowserTimeout: Optional[int]
80
69
  """
81
- The timeout in seconds for the external browser to complete the authentication. Can also be sourced from the
82
- `SNOWFLAKE_EXTERNAL_BROWSER_TIMEOUT` environment variable.
70
+ The timeout in seconds for the external browser to complete the authentication. Can also be sourced from the `SNOWFLAKE_EXTERNAL_BROWSER_TIMEOUT` environment variable.
83
71
  """
84
72
 
85
73
  host: Optional[str]
86
74
  """
87
- Specifies a custom host value used by the driver for privatelink connections. Can also be sourced from the
88
- `SNOWFLAKE_HOST` environment variable.
75
+ Specifies a custom host value used by the driver for privatelink connections. Can also be sourced from the `SNOWFLAKE_HOST` environment variable.
89
76
  """
90
77
 
91
78
  includeRetryReason: Optional[str]
92
79
  """
93
- Should retried request contain retry reason. Can also be sourced from the `SNOWFLAKE_INCLUDE_RETRY_REASON` environment
94
- variable.
80
+ Should retried request contain retry reason. Can also be sourced from the `SNOWFLAKE_INCLUDE_RETRY_REASON` environment variable.
95
81
  """
96
82
 
97
83
  insecureMode: Optional[bool]
98
84
  """
99
- If true, bypass the Online Certificate Status Protocol (OCSP) certificate revocation check. IMPORTANT: Change the
100
- default value for testing or emergency situations only. Can also be sourced from the `SNOWFLAKE_INSECURE_MODE`
101
- environment variable.
85
+ If true, bypass the Online Certificate Status Protocol (OCSP) certificate revocation check. IMPORTANT: Change the default value for testing or emergency situations only. Can also be sourced from the `SNOWFLAKE_INSECURE_MODE` environment variable.
102
86
  """
103
87
 
104
88
  jwtClientTimeout: Optional[int]
105
89
  """
106
- The timeout in seconds for the JWT client to complete the authentication. Can also be sourced from the
107
- `SNOWFLAKE_JWT_CLIENT_TIMEOUT` environment variable.
90
+ The timeout in seconds for the JWT client to complete the authentication. Can also be sourced from the `SNOWFLAKE_JWT_CLIENT_TIMEOUT` environment variable.
108
91
  """
109
92
 
110
93
  jwtExpireTimeout: Optional[int]
@@ -114,140 +97,111 @@ JWT expire after timeout in seconds. Can also be sourced from the `SNOWFLAKE_JWT
114
97
 
115
98
  keepSessionAlive: Optional[bool]
116
99
  """
117
- Enables the session to persist even after the connection is closed. Can also be sourced from the
118
- `SNOWFLAKE_KEEP_SESSION_ALIVE` environment variable.
100
+ Enables the session to persist even after the connection is closed. Can also be sourced from the `SNOWFLAKE_KEEP_SESSION_ALIVE` environment variable.
119
101
  """
120
102
 
121
103
  loginTimeout: Optional[int]
122
104
  """
123
- Login retry timeout in seconds EXCLUDING network roundtrip and read out http response. Can also be sourced from the
124
- `SNOWFLAKE_LOGIN_TIMEOUT` environment variable.
105
+ Login retry timeout in seconds EXCLUDING network roundtrip and read out http response. Can also be sourced from the `SNOWFLAKE_LOGIN_TIMEOUT` environment variable.
125
106
  """
126
107
 
127
108
  maxRetryCount: Optional[int]
128
109
  """
129
- Specifies how many times non-periodic HTTP request can be retried by the driver. Can also be sourced from the
130
- `SNOWFLAKE_MAX_RETRY_COUNT` environment variable.
110
+ Specifies how many times non-periodic HTTP request can be retried by the driver. Can also be sourced from the `SNOWFLAKE_MAX_RETRY_COUNT` environment variable.
131
111
  """
132
112
 
133
113
  ocspFailOpen: Optional[str]
134
114
  """
135
- True represents OCSP fail open mode. False represents OCSP fail closed mode. Fail open true by default. Can also be
136
- sourced from the `SNOWFLAKE_OCSP_FAIL_OPEN` environment variable.
115
+ True represents OCSP fail open mode. False represents OCSP fail closed mode. Fail open true by default. Can also be sourced from the `SNOWFLAKE_OCSP_FAIL_OPEN` environment variable.
137
116
  """
138
117
 
139
118
  oktaUrl: Optional[str]
140
119
  """
141
- The URL of the Okta server. e.g. https://example.okta.com. Okta URL host needs to to have a suffix `okta.com`. Read more
142
- in Snowflake [docs](https://docs.snowflake.com/en/user-guide/oauth-okta). Can also be sourced from the
143
- `SNOWFLAKE_OKTA_URL` environment variable.
120
+ The URL of the Okta server. e.g. https://example.okta.com. Okta URL host needs to to have a suffix `okta.com`. Read more in Snowflake [docs](https://docs.snowflake.com/en/user-guide/oauth-okta). Can also be sourced from the `SNOWFLAKE_OKTA_URL` environment variable.
144
121
  """
145
122
 
146
123
  organizationName: Optional[str]
147
124
  """
148
- Specifies your Snowflake organization name assigned by Snowflake. For information about account identifiers, see the
149
- [Snowflake documentation](https://docs.snowflake.com/en/user-guide/admin-account-identifier#organization-name). Required
150
- unless using `profile`. Can also be sourced from the `SNOWFLAKE_ORGANIZATION_NAME` environment variable.
125
+ Specifies your Snowflake organization name assigned by Snowflake. For information about account identifiers, see the [Snowflake documentation](https://docs.snowflake.com/en/user-guide/admin-account-identifier#organization-name). Required unless using `profile`. Can also be sourced from the `SNOWFLAKE_ORGANIZATION_NAME` environment variable.
151
126
  """
152
127
 
153
128
  params: Optional[str]
154
129
  """
155
- Sets other connection (i.e. session) parameters. [Parameters](https://docs.snowflake.com/en/sql-reference/parameters).
156
- This field can not be set with environmental variables.
130
+ Sets other connection (i.e. session) parameters. [Parameters](https://docs.snowflake.com/en/sql-reference/parameters). This field can not be set with environmental variables.
157
131
  """
158
132
 
159
133
  passcode: Optional[str]
160
134
  """
161
- Specifies the passcode provided by Duo when using multi-factor authentication (MFA) for login. Can also be sourced from
162
- the `SNOWFLAKE_PASSCODE` environment variable.
135
+ Specifies the passcode provided by Duo when using multi-factor authentication (MFA) for login. Can also be sourced from the `SNOWFLAKE_PASSCODE` environment variable.
163
136
  """
164
137
 
165
138
  passcodeInPassword: Optional[bool]
166
139
  """
167
- False by default. Set to true if the MFA passcode is embedded to the configured password. Can also be sourced from the
168
- `SNOWFLAKE_PASSCODE_IN_PASSWORD` environment variable.
140
+ False by default. Set to true if the MFA passcode is embedded to the configured password. Can also be sourced from the `SNOWFLAKE_PASSCODE_IN_PASSWORD` environment variable.
169
141
  """
170
142
 
171
143
  password: Optional[str]
172
144
  """
173
- Password for user + password or
174
- [token](https://docs.snowflake.com/en/user-guide/programmatic-access-tokens#generating-a-programmatic-access-token) for
175
- [PAT auth](https://docs.snowflake.com/en/user-guide/programmatic-access-tokens). Cannot be used with `private_key` and
176
- `private_key_passphrase`. Can also be sourced from the `SNOWFLAKE_PASSWORD` environment variable.
145
+ Password for user + password or [token](https://docs.snowflake.com/en/user-guide/programmatic-access-tokens#generating-a-programmatic-access-token) for [PAT auth](https://docs.snowflake.com/en/user-guide/programmatic-access-tokens). Cannot be used with `private_key` and `private_key_passphrase`. Can also be sourced from the `SNOWFLAKE_PASSWORD` environment variable.
177
146
  """
178
147
 
179
148
  port: Optional[int]
180
149
  """
181
- Specifies a custom port value used by the driver for privatelink connections. Can also be sourced from the
182
- `SNOWFLAKE_PORT` environment variable.
150
+ Specifies a custom port value used by the driver for privatelink connections. Can also be sourced from the `SNOWFLAKE_PORT` environment variable.
183
151
  """
184
152
 
185
153
  previewFeaturesEnabled: Optional[str]
186
154
 
187
155
  privateKey: Optional[str]
188
156
  """
189
- Private Key for username+private-key auth. Cannot be used with `password`. Can also be sourced from the
190
- `SNOWFLAKE_PRIVATE_KEY` environment variable.
157
+ Private Key for username+private-key auth. Cannot be used with `password`. Can also be sourced from the `SNOWFLAKE_PRIVATE_KEY` environment variable.
191
158
  """
192
159
 
193
160
  privateKeyPassphrase: Optional[str]
194
161
  """
195
- Supports the encryption ciphers aes-128-cbc, aes-128-gcm, aes-192-cbc, aes-192-gcm, aes-256-cbc, aes-256-gcm, and
196
- des-ede3-cbc. Can also be sourced from the `SNOWFLAKE_PRIVATE_KEY_PASSPHRASE` environment variable.
162
+ Supports the encryption ciphers aes-128-cbc, aes-128-gcm, aes-192-cbc, aes-192-gcm, aes-256-cbc, aes-256-gcm, and des-ede3-cbc. Can also be sourced from the `SNOWFLAKE_PRIVATE_KEY_PASSPHRASE` environment variable.
197
163
  """
198
164
 
199
165
  profile: Optional[str]
200
166
  """
201
- Sets the profile to read from ~/.snowflake/config file. Can also be sourced from the `SNOWFLAKE_PROFILE` environment
202
- variable.
167
+ Sets the profile to read from ~/.snowflake/config file. Can also be sourced from the `SNOWFLAKE_PROFILE` environment variable.
203
168
  """
204
169
 
205
170
  protocol: Optional[str]
206
171
  """
207
- A protocol used in the connection. Valid options are: `http` | `https`. Can also be sourced from the
208
- `SNOWFLAKE_PROTOCOL` environment variable.
172
+ A protocol used in the connection. Valid options are: `http` | `https`. Can also be sourced from the `SNOWFLAKE_PROTOCOL` environment variable.
209
173
  """
210
174
 
211
175
  requestTimeout: Optional[int]
212
176
  """
213
- request retry timeout in seconds EXCLUDING network roundtrip and read out http response. Can also be sourced from the
214
- `SNOWFLAKE_REQUEST_TIMEOUT` environment variable.
177
+ request retry timeout in seconds EXCLUDING network roundtrip and read out http response. Can also be sourced from the `SNOWFLAKE_REQUEST_TIMEOUT` environment variable.
215
178
  """
216
179
 
217
180
  role: Optional[str]
218
181
  """
219
- Specifies the role to use by default for accessing Snowflake objects in the client session. Can also be sourced from the
220
- `SNOWFLAKE_ROLE` environment variable.
182
+ Specifies the role to use by default for accessing Snowflake objects in the client session. Can also be sourced from the `SNOWFLAKE_ROLE` environment variable.
221
183
  """
222
184
 
223
185
  skipTomlFilePermissionVerification: Optional[bool]
224
186
  """
225
- False by default. Skips TOML configuration file permission verification. This flag has no effect on Windows systems, as
226
- the permissions are not checked on this platform. Instead of skipping the permissions verification, we recommend setting
227
- the proper privileges - see the section below. Can also be sourced from the
228
- `SNOWFLAKE_SKIP_TOML_FILE_PERMISSION_VERIFICATION` environment variable.
187
+ False by default. Skips TOML configuration file permission verification. This flag has no effect on Windows systems, as the permissions are not checked on this platform. Instead of skipping the permissions verification, we recommend setting the proper privileges - see the section below. Can also be sourced from the `SNOWFLAKE_SKIP_TOML_FILE_PERMISSION_VERIFICATION` environment variable.
229
188
  """
230
189
 
231
190
  tmpDirectoryPath: Optional[str]
232
191
  """
233
- Sets temporary directory used by the driver for operations like encrypting, compressing etc. Can also be sourced from
234
- the `SNOWFLAKE_TMP_DIRECTORY_PATH` environment variable.
192
+ Sets temporary directory used by the driver for operations like encrypting, compressing etc. Can also be sourced from the `SNOWFLAKE_TMP_DIRECTORY_PATH` environment variable.
235
193
  """
236
194
 
237
195
  token: Optional[str]
238
196
  """
239
- Token to use for OAuth and other forms of token based auth. When this field is set here, or in the TOML file, the
240
- provider sets the `authenticator` to `OAUTH`. Optionally, set the `authenticator` field to the authenticator you want to
241
- use. Can also be sourced from the `SNOWFLAKE_TOKEN` environment variable.
197
+ Token to use for OAuth and other forms of token based auth. When this field is set here, or in the TOML file, the provider sets the `authenticator` to `OAUTH`. Optionally, set the `authenticator` field to the authenticator you want to use. Can also be sourced from the `SNOWFLAKE_TOKEN` environment variable.
242
198
  """
243
199
 
244
200
  tokenAccessor: Optional[str]
245
201
 
246
202
  useLegacyTomlFile: Optional[bool]
247
203
  """
248
- False by default. When this is set to true, the provider expects the legacy TOML format. Otherwise, it expects the new
249
- format. See more in the section below Can also be sourced from the `SNOWFLAKE_USE_LEGACY_TOML_FILE` environment
250
- variable.
204
+ False by default. When this is set to true, the provider expects the legacy TOML format. Otherwise, it expects the new format. See more in the section below Can also be sourced from the `SNOWFLAKE_USE_LEGACY_TOML_FILE` environment variable.
251
205
  """
252
206
 
253
207
  user: Optional[str]
@@ -257,13 +211,11 @@ Username. Required unless using `profile`. Can also be sourced from the `SNOWFLA
257
211
 
258
212
  validateDefaultParameters: Optional[str]
259
213
  """
260
- True by default. If false, disables the validation checks for Database, Schema, Warehouse and Role at the time a
261
- connection is established. Can also be sourced from the `SNOWFLAKE_VALIDATE_DEFAULT_PARAMETERS` environment variable.
214
+ True by default. If false, disables the validation checks for Database, Schema, Warehouse and Role at the time a connection is established. Can also be sourced from the `SNOWFLAKE_VALIDATE_DEFAULT_PARAMETERS` environment variable.
262
215
  """
263
216
 
264
217
  warehouse: Optional[str]
265
218
  """
266
- Specifies the virtual warehouse to use by default for queries, loading, etc. in the client session. Can also be sourced
267
- from the `SNOWFLAKE_WAREHOUSE` environment variable.
219
+ Specifies the virtual warehouse to use by default for queries, loading, etc. in the client session. Can also be sourced from the `SNOWFLAKE_WAREHOUSE` environment variable.
268
220
  """
269
221
 
pulumi_snowflake/config/vars.py CHANGED
@@ -24,19 +24,14 @@ class _ExportableConfig(types.ModuleType):
24
24
  @_builtins.property
25
25
  def account_name(self) -> Optional[str]:
26
26
  """
27
- Specifies your Snowflake account name assigned by Snowflake. For information about account identifiers, see the
28
- [Snowflake documentation](https://docs.snowflake.com/en/user-guide/admin-account-identifier#account-name). Required
29
- unless using `profile`. Can also be sourced from the `SNOWFLAKE_ACCOUNT_NAME` environment variable.
27
+ Specifies your Snowflake account name assigned by Snowflake. For information about account identifiers, see the [Snowflake documentation](https://docs.snowflake.com/en/user-guide/admin-account-identifier#account-name). Required unless using `profile`. Can also be sourced from the `SNOWFLAKE_ACCOUNT_NAME` environment variable.
30
28
  """
31
29
  return __config__.get('accountName')
32
30
 
33
31
  @_builtins.property
34
32
  def authenticator(self) -> Optional[str]:
35
33
  """
36
- Specifies the [authentication type](https://pkg.go.dev/github.com/snowflakedb/gosnowflake#AuthType) to use when
37
- connecting to Snowflake. Valid options are: `SNOWFLAKE` | `OAUTH` | `EXTERNALBROWSER` | `OKTA` | `SNOWFLAKE_JWT` |
38
- `TOKENACCESSOR` | `USERNAMEPASSWORDMFA` | `PROGRAMMATIC_ACCESS_TOKEN`. Can also be sourced from the
39
- `SNOWFLAKE_AUTHENTICATOR` environment variable.
34
+ Specifies the [authentication type](https://pkg.go.dev/github.com/snowflakedb/gosnowflake#AuthType) to use when connecting to Snowflake. Valid options are: `SNOWFLAKE` | `OAUTH` | `EXTERNALBROWSER` | `OKTA` | `SNOWFLAKE_JWT` | `TOKENACCESSOR` | `USERNAMEPASSWORDMFA` | `PROGRAMMATIC_ACCESS_TOKEN`. Can also be sourced from the `SNOWFLAKE_AUTHENTICATOR` environment variable.
40
35
  """
41
36
  return __config__.get('authenticator')
42
37
 
@@ -50,40 +45,35 @@ class _ExportableConfig(types.ModuleType):
50
45
  @_builtins.property
51
46
  def client_request_mfa_token(self) -> Optional[str]:
52
47
  """
53
- When true the MFA token is cached in the credential manager. True by default in Windows/OSX. False for Linux. Can also
54
- be sourced from the `SNOWFLAKE_CLIENT_REQUEST_MFA_TOKEN` environment variable.
48
+ When true the MFA token is cached in the credential manager. True by default in Windows/OSX. False for Linux. Can also be sourced from the `SNOWFLAKE_CLIENT_REQUEST_MFA_TOKEN` environment variable.
55
49
  """
56
50
  return __config__.get('clientRequestMfaToken')
57
51
 
58
52
  @_builtins.property
59
53
  def client_store_temporary_credential(self) -> Optional[str]:
60
54
  """
61
- When true the ID token is cached in the credential manager. True by default in Windows/OSX. False for Linux. Can also be
62
- sourced from the `SNOWFLAKE_CLIENT_STORE_TEMPORARY_CREDENTIAL` environment variable.
55
+ When true the ID token is cached in the credential manager. True by default in Windows/OSX. False for Linux. Can also be sourced from the `SNOWFLAKE_CLIENT_STORE_TEMPORARY_CREDENTIAL` environment variable.
63
56
  """
64
57
  return __config__.get('clientStoreTemporaryCredential')
65
58
 
66
59
  @_builtins.property
67
60
  def client_timeout(self) -> Optional[int]:
68
61
  """
69
- The timeout in seconds for the client to complete the authentication. Can also be sourced from the
70
- `SNOWFLAKE_CLIENT_TIMEOUT` environment variable.
62
+ The timeout in seconds for the client to complete the authentication. Can also be sourced from the `SNOWFLAKE_CLIENT_TIMEOUT` environment variable.
71
63
  """
72
64
  return __config__.get_int('clientTimeout')
73
65
 
74
66
  @_builtins.property
75
67
  def disable_console_login(self) -> Optional[str]:
76
68
  """
77
- Indicates whether console login should be disabled in the driver. Can also be sourced from the
78
- `SNOWFLAKE_DISABLE_CONSOLE_LOGIN` environment variable.
69
+ Indicates whether console login should be disabled in the driver. Can also be sourced from the `SNOWFLAKE_DISABLE_CONSOLE_LOGIN` environment variable.
79
70
  """
80
71
  return __config__.get('disableConsoleLogin')
81
72
 
82
73
  @_builtins.property
83
74
  def disable_query_context_cache(self) -> Optional[bool]:
84
75
  """
85
- Disables HTAP query context cache in the driver. Can also be sourced from the `SNOWFLAKE_DISABLE_QUERY_CONTEXT_CACHE`
86
- environment variable.
76
+ Disables HTAP query context cache in the driver. Can also be sourced from the `SNOWFLAKE_DISABLE_QUERY_CONTEXT_CACHE` environment variable.
87
77
  """
88
78
  return __config__.get_bool('disableQueryContextCache')
89
79
 
@@ -97,49 +87,42 @@ class _ExportableConfig(types.ModuleType):
97
87
  @_builtins.property
98
88
  def driver_tracing(self) -> Optional[str]:
99
89
  """
100
- Specifies the logging level to be used by the driver. Valid options are: `trace` | `debug` | `info` | `print` |
101
- `warning` | `error` | `fatal` | `panic`. Can also be sourced from the `SNOWFLAKE_DRIVER_TRACING` environment variable.
90
+ Specifies the logging level to be used by the driver. Valid options are: `trace` | `debug` | `info` | `print` | `warning` | `error` | `fatal` | `panic`. Can also be sourced from the `SNOWFLAKE_DRIVER_TRACING` environment variable.
102
91
  """
103
92
  return __config__.get('driverTracing')
104
93
 
105
94
  @_builtins.property
106
95
  def external_browser_timeout(self) -> Optional[int]:
107
96
  """
108
- The timeout in seconds for the external browser to complete the authentication. Can also be sourced from the
109
- `SNOWFLAKE_EXTERNAL_BROWSER_TIMEOUT` environment variable.
97
+ The timeout in seconds for the external browser to complete the authentication. Can also be sourced from the `SNOWFLAKE_EXTERNAL_BROWSER_TIMEOUT` environment variable.
110
98
  """
111
99
  return __config__.get_int('externalBrowserTimeout')
112
100
 
113
101
  @_builtins.property
114
102
  def host(self) -> Optional[str]:
115
103
  """
116
- Specifies a custom host value used by the driver for privatelink connections. Can also be sourced from the
117
- `SNOWFLAKE_HOST` environment variable.
104
+ Specifies a custom host value used by the driver for privatelink connections. Can also be sourced from the `SNOWFLAKE_HOST` environment variable.
118
105
  """
119
106
  return __config__.get('host') or _utilities.get_env('SNOWFLAKE_HOST')
120
107
 
121
108
  @_builtins.property
122
109
  def include_retry_reason(self) -> Optional[str]:
123
110
  """
124
- Should retried request contain retry reason. Can also be sourced from the `SNOWFLAKE_INCLUDE_RETRY_REASON` environment
125
- variable.
111
+ Should retried request contain retry reason. Can also be sourced from the `SNOWFLAKE_INCLUDE_RETRY_REASON` environment variable.
126
112
  """
127
113
  return __config__.get('includeRetryReason')
128
114
 
129
115
  @_builtins.property
130
116
  def insecure_mode(self) -> Optional[bool]:
131
117
  """
132
- If true, bypass the Online Certificate Status Protocol (OCSP) certificate revocation check. IMPORTANT: Change the
133
- default value for testing or emergency situations only. Can also be sourced from the `SNOWFLAKE_INSECURE_MODE`
134
- environment variable.
118
+ If true, bypass the Online Certificate Status Protocol (OCSP) certificate revocation check. IMPORTANT: Change the default value for testing or emergency situations only. Can also be sourced from the `SNOWFLAKE_INSECURE_MODE` environment variable.
135
119
  """
136
120
  return __config__.get_bool('insecureMode')
137
121
 
138
122
  @_builtins.property
139
123
  def jwt_client_timeout(self) -> Optional[int]:
140
124
  """
141
- The timeout in seconds for the JWT client to complete the authentication. Can also be sourced from the
142
- `SNOWFLAKE_JWT_CLIENT_TIMEOUT` environment variable.
125
+ The timeout in seconds for the JWT client to complete the authentication. Can also be sourced from the `SNOWFLAKE_JWT_CLIENT_TIMEOUT` environment variable.
143
126
  """
144
127
  return __config__.get_int('jwtClientTimeout')
145
128
 
@@ -153,92 +136,77 @@ class _ExportableConfig(types.ModuleType):
153
136
  @_builtins.property
154
137
  def keep_session_alive(self) -> Optional[bool]:
155
138
  """
156
- Enables the session to persist even after the connection is closed. Can also be sourced from the
157
- `SNOWFLAKE_KEEP_SESSION_ALIVE` environment variable.
139
+ Enables the session to persist even after the connection is closed. Can also be sourced from the `SNOWFLAKE_KEEP_SESSION_ALIVE` environment variable.
158
140
  """
159
141
  return __config__.get_bool('keepSessionAlive')
160
142
 
161
143
  @_builtins.property
162
144
  def login_timeout(self) -> Optional[int]:
163
145
  """
164
- Login retry timeout in seconds EXCLUDING network roundtrip and read out http response. Can also be sourced from the
165
- `SNOWFLAKE_LOGIN_TIMEOUT` environment variable.
146
+ Login retry timeout in seconds EXCLUDING network roundtrip and read out http response. Can also be sourced from the `SNOWFLAKE_LOGIN_TIMEOUT` environment variable.
166
147
  """
167
148
  return __config__.get_int('loginTimeout')
168
149
 
169
150
  @_builtins.property
170
151
  def max_retry_count(self) -> Optional[int]:
171
152
  """
172
- Specifies how many times non-periodic HTTP request can be retried by the driver. Can also be sourced from the
173
- `SNOWFLAKE_MAX_RETRY_COUNT` environment variable.
153
+ Specifies how many times non-periodic HTTP request can be retried by the driver. Can also be sourced from the `SNOWFLAKE_MAX_RETRY_COUNT` environment variable.
174
154
  """
175
155
  return __config__.get_int('maxRetryCount')
176
156
 
177
157
  @_builtins.property
178
158
  def ocsp_fail_open(self) -> Optional[str]:
179
159
  """
180
- True represents OCSP fail open mode. False represents OCSP fail closed mode. Fail open true by default. Can also be
181
- sourced from the `SNOWFLAKE_OCSP_FAIL_OPEN` environment variable.
160
+ True represents OCSP fail open mode. False represents OCSP fail closed mode. Fail open true by default. Can also be sourced from the `SNOWFLAKE_OCSP_FAIL_OPEN` environment variable.
182
161
  """
183
162
  return __config__.get('ocspFailOpen')
184
163
 
185
164
  @_builtins.property
186
165
  def okta_url(self) -> Optional[str]:
187
166
  """
188
- The URL of the Okta server. e.g. https://example.okta.com. Okta URL host needs to to have a suffix `okta.com`. Read more
189
- in Snowflake [docs](https://docs.snowflake.com/en/user-guide/oauth-okta). Can also be sourced from the
190
- `SNOWFLAKE_OKTA_URL` environment variable.
167
+ The URL of the Okta server. e.g. https://example.okta.com. Okta URL host needs to to have a suffix `okta.com`. Read more in Snowflake [docs](https://docs.snowflake.com/en/user-guide/oauth-okta). Can also be sourced from the `SNOWFLAKE_OKTA_URL` environment variable.
191
168
  """
192
169
  return __config__.get('oktaUrl')
193
170
 
194
171
  @_builtins.property
195
172
  def organization_name(self) -> Optional[str]:
196
173
  """
197
- Specifies your Snowflake organization name assigned by Snowflake. For information about account identifiers, see the
198
- [Snowflake documentation](https://docs.snowflake.com/en/user-guide/admin-account-identifier#organization-name). Required
199
- unless using `profile`. Can also be sourced from the `SNOWFLAKE_ORGANIZATION_NAME` environment variable.
174
+ Specifies your Snowflake organization name assigned by Snowflake. For information about account identifiers, see the [Snowflake documentation](https://docs.snowflake.com/en/user-guide/admin-account-identifier#organization-name). Required unless using `profile`. Can also be sourced from the `SNOWFLAKE_ORGANIZATION_NAME` environment variable.
200
175
  """
201
176
  return __config__.get('organizationName')
202
177
 
203
178
  @_builtins.property
204
179
  def params(self) -> Optional[str]:
205
180
  """
206
- Sets other connection (i.e. session) parameters. [Parameters](https://docs.snowflake.com/en/sql-reference/parameters).
207
- This field can not be set with environmental variables.
181
+ Sets other connection (i.e. session) parameters. [Parameters](https://docs.snowflake.com/en/sql-reference/parameters). This field can not be set with environmental variables.
208
182
  """
209
183
  return __config__.get('params')
210
184
 
211
185
  @_builtins.property
212
186
  def passcode(self) -> Optional[str]:
213
187
  """
214
- Specifies the passcode provided by Duo when using multi-factor authentication (MFA) for login. Can also be sourced from
215
- the `SNOWFLAKE_PASSCODE` environment variable.
188
+ Specifies the passcode provided by Duo when using multi-factor authentication (MFA) for login. Can also be sourced from the `SNOWFLAKE_PASSCODE` environment variable.
216
189
  """
217
190
  return __config__.get('passcode')
218
191
 
219
192
  @_builtins.property
220
193
  def passcode_in_password(self) -> Optional[bool]:
221
194
  """
222
- False by default. Set to true if the MFA passcode is embedded to the configured password. Can also be sourced from the
223
- `SNOWFLAKE_PASSCODE_IN_PASSWORD` environment variable.
195
+ False by default. Set to true if the MFA passcode is embedded to the configured password. Can also be sourced from the `SNOWFLAKE_PASSCODE_IN_PASSWORD` environment variable.
224
196
  """
225
197
  return __config__.get_bool('passcodeInPassword')
226
198
 
227
199
  @_builtins.property
228
200
  def password(self) -> Optional[str]:
229
201
  """
230
- Password for user + password or
231
- [token](https://docs.snowflake.com/en/user-guide/programmatic-access-tokens#generating-a-programmatic-access-token) for
232
- [PAT auth](https://docs.snowflake.com/en/user-guide/programmatic-access-tokens). Cannot be used with `private_key` and
233
- `private_key_passphrase`. Can also be sourced from the `SNOWFLAKE_PASSWORD` environment variable.
202
+ Password for user + password or [token](https://docs.snowflake.com/en/user-guide/programmatic-access-tokens#generating-a-programmatic-access-token) for [PAT auth](https://docs.snowflake.com/en/user-guide/programmatic-access-tokens). Cannot be used with `private_key` and `private_key_passphrase`. Can also be sourced from the `SNOWFLAKE_PASSWORD` environment variable.
234
203
  """
235
204
  return __config__.get('password') or _utilities.get_env('SNOWFLAKE_PASSWORD')
236
205
 
237
206
  @_builtins.property
238
207
  def port(self) -> Optional[int]:
239
208
  """
240
- Specifies a custom port value used by the driver for privatelink connections. Can also be sourced from the
241
- `SNOWFLAKE_PORT` environment variable.
209
+ Specifies a custom port value used by the driver for privatelink connections. Can also be sourced from the `SNOWFLAKE_PORT` environment variable.
242
210
  """
243
211
  return __config__.get_int('port') or _utilities.get_env_int('SNOWFLAKE_PORT')
244
212
 
@@ -249,75 +217,63 @@ class _ExportableConfig(types.ModuleType):
249
217
  @_builtins.property
250
218
  def private_key(self) -> Optional[str]:
251
219
  """
252
- Private Key for username+private-key auth. Cannot be used with `password`. Can also be sourced from the
253
- `SNOWFLAKE_PRIVATE_KEY` environment variable.
220
+ Private Key for username+private-key auth. Cannot be used with `password`. Can also be sourced from the `SNOWFLAKE_PRIVATE_KEY` environment variable.
254
221
  """
255
222
  return __config__.get('privateKey')
256
223
 
257
224
  @_builtins.property
258
225
  def private_key_passphrase(self) -> Optional[str]:
259
226
  """
260
- Supports the encryption ciphers aes-128-cbc, aes-128-gcm, aes-192-cbc, aes-192-gcm, aes-256-cbc, aes-256-gcm, and
261
- des-ede3-cbc. Can also be sourced from the `SNOWFLAKE_PRIVATE_KEY_PASSPHRASE` environment variable.
227
+ Supports the encryption ciphers aes-128-cbc, aes-128-gcm, aes-192-cbc, aes-192-gcm, aes-256-cbc, aes-256-gcm, and des-ede3-cbc. Can also be sourced from the `SNOWFLAKE_PRIVATE_KEY_PASSPHRASE` environment variable.
262
228
  """
263
229
  return __config__.get('privateKeyPassphrase') or _utilities.get_env('SNOWFLAKE_PRIVATE_KEY_PASSPHRASE')
264
230
 
265
231
  @_builtins.property
266
232
  def profile(self) -> Optional[str]:
267
233
  """
268
- Sets the profile to read from ~/.snowflake/config file. Can also be sourced from the `SNOWFLAKE_PROFILE` environment
269
- variable.
234
+ Sets the profile to read from ~/.snowflake/config file. Can also be sourced from the `SNOWFLAKE_PROFILE` environment variable.
270
235
  """
271
236
  return __config__.get('profile')
272
237
 
273
238
  @_builtins.property
274
239
  def protocol(self) -> Optional[str]:
275
240
  """
276
- A protocol used in the connection. Valid options are: `http` | `https`. Can also be sourced from the
277
- `SNOWFLAKE_PROTOCOL` environment variable.
241
+ A protocol used in the connection. Valid options are: `http` | `https`. Can also be sourced from the `SNOWFLAKE_PROTOCOL` environment variable.
278
242
  """
279
243
  return __config__.get('protocol') or _utilities.get_env('SNOWFLAKE_PROTOCOL')
280
244
 
281
245
  @_builtins.property
282
246
  def request_timeout(self) -> Optional[int]:
283
247
  """
284
- request retry timeout in seconds EXCLUDING network roundtrip and read out http response. Can also be sourced from the
285
- `SNOWFLAKE_REQUEST_TIMEOUT` environment variable.
248
+ request retry timeout in seconds EXCLUDING network roundtrip and read out http response. Can also be sourced from the `SNOWFLAKE_REQUEST_TIMEOUT` environment variable.
286
249
  """
287
250
  return __config__.get_int('requestTimeout')
288
251
 
289
252
  @_builtins.property
290
253
  def role(self) -> Optional[str]:
291
254
  """
292
- Specifies the role to use by default for accessing Snowflake objects in the client session. Can also be sourced from the
293
- `SNOWFLAKE_ROLE` environment variable.
255
+ Specifies the role to use by default for accessing Snowflake objects in the client session. Can also be sourced from the `SNOWFLAKE_ROLE` environment variable.
294
256
  """
295
257
  return __config__.get('role') or _utilities.get_env('SNOWFLAKE_ROLE')
296
258
 
297
259
  @_builtins.property
298
260
  def skip_toml_file_permission_verification(self) -> Optional[bool]:
299
261
  """
300
- False by default. Skips TOML configuration file permission verification. This flag has no effect on Windows systems, as
301
- the permissions are not checked on this platform. Instead of skipping the permissions verification, we recommend setting
302
- the proper privileges - see the section below. Can also be sourced from the
303
- `SNOWFLAKE_SKIP_TOML_FILE_PERMISSION_VERIFICATION` environment variable.
262
+ False by default. Skips TOML configuration file permission verification. This flag has no effect on Windows systems, as the permissions are not checked on this platform. Instead of skipping the permissions verification, we recommend setting the proper privileges - see the section below. Can also be sourced from the `SNOWFLAKE_SKIP_TOML_FILE_PERMISSION_VERIFICATION` environment variable.
304
263
  """
305
264
  return __config__.get_bool('skipTomlFilePermissionVerification')
306
265
 
307
266
  @_builtins.property
308
267
  def tmp_directory_path(self) -> Optional[str]:
309
268
  """
310
- Sets temporary directory used by the driver for operations like encrypting, compressing etc. Can also be sourced from
311
- the `SNOWFLAKE_TMP_DIRECTORY_PATH` environment variable.
269
+ Sets temporary directory used by the driver for operations like encrypting, compressing etc. Can also be sourced from the `SNOWFLAKE_TMP_DIRECTORY_PATH` environment variable.
312
270
  """
313
271
  return __config__.get('tmpDirectoryPath')
314
272
 
315
273
  @_builtins.property
316
274
  def token(self) -> Optional[str]:
317
275
  """
318
- Token to use for OAuth and other forms of token based auth. When this field is set here, or in the TOML file, the
319
- provider sets the `authenticator` to `OAUTH`. Optionally, set the `authenticator` field to the authenticator you want to
320
- use. Can also be sourced from the `SNOWFLAKE_TOKEN` environment variable.
276
+ Token to use for OAuth and other forms of token based auth. When this field is set here, or in the TOML file, the provider sets the `authenticator` to `OAUTH`. Optionally, set the `authenticator` field to the authenticator you want to use. Can also be sourced from the `SNOWFLAKE_TOKEN` environment variable.
321
277
  """
322
278
  return __config__.get('token')
323
279
 
@@ -328,9 +284,7 @@ class _ExportableConfig(types.ModuleType):
328
284
  @_builtins.property
329
285
  def use_legacy_toml_file(self) -> Optional[bool]:
330
286
  """
331
- False by default. When this is set to true, the provider expects the legacy TOML format. Otherwise, it expects the new
332
- format. See more in the section below Can also be sourced from the `SNOWFLAKE_USE_LEGACY_TOML_FILE` environment
333
- variable.
287
+ False by default. When this is set to true, the provider expects the legacy TOML format. Otherwise, it expects the new format. See more in the section below Can also be sourced from the `SNOWFLAKE_USE_LEGACY_TOML_FILE` environment variable.
334
288
  """
335
289
  return __config__.get_bool('useLegacyTomlFile')
336
290
 
@@ -344,16 +298,14 @@ class _ExportableConfig(types.ModuleType):
344
298
  @_builtins.property
345
299
  def validate_default_parameters(self) -> Optional[str]:
346
300
  """
347
- True by default. If false, disables the validation checks for Database, Schema, Warehouse and Role at the time a
348
- connection is established. Can also be sourced from the `SNOWFLAKE_VALIDATE_DEFAULT_PARAMETERS` environment variable.
301
+ True by default. If false, disables the validation checks for Database, Schema, Warehouse and Role at the time a connection is established. Can also be sourced from the `SNOWFLAKE_VALIDATE_DEFAULT_PARAMETERS` environment variable.
349
302
  """
350
303
  return __config__.get('validateDefaultParameters')
351
304
 
352
305
  @_builtins.property
353
306
  def warehouse(self) -> Optional[str]:
354
307
  """
355
- Specifies the virtual warehouse to use by default for queries, loading, etc. in the client session. Can also be sourced
356
- from the `SNOWFLAKE_WAREHOUSE` environment variable.
308
+ Specifies the virtual warehouse to use by default for queries, loading, etc. in the client session. Can also be sourced from the `SNOWFLAKE_WAREHOUSE` environment variable.
357
309
  """
358
310
  return __config__.get('warehouse') or _utilities.get_env('SNOWFLAKE_WAREHOUSE')
359
311