pulumi-snowflake 0.61.0a1731393894__py3-none-any.whl → 0.61.1__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.
- pulumi_snowflake/__init__.py +110 -0
- pulumi_snowflake/_inputs.py +5182 -1837
- pulumi_snowflake/account_authentication_policy_attachment.py +149 -0
- pulumi_snowflake/authentication_policy.py +622 -0
- pulumi_snowflake/config/__init__.pyi +86 -36
- pulumi_snowflake/config/vars.py +104 -40
- pulumi_snowflake/external_volume.py +378 -0
- pulumi_snowflake/get_connections.py +147 -0
- pulumi_snowflake/get_grants.py +4 -0
- pulumi_snowflake/get_secrets.py +204 -0
- pulumi_snowflake/get_streams.py +105 -56
- pulumi_snowflake/grant_account_role.py +2 -2
- pulumi_snowflake/grant_application_role.py +2 -2
- pulumi_snowflake/grant_database_role.py +2 -2
- pulumi_snowflake/grant_ownership.py +14 -14
- pulumi_snowflake/grant_privileges_to_account_role.py +8 -8
- pulumi_snowflake/grant_privileges_to_database_role.py +8 -8
- pulumi_snowflake/grant_privileges_to_share.py +2 -2
- pulumi_snowflake/legacy_service_user.py +4 -0
- pulumi_snowflake/outputs.py +4390 -1335
- pulumi_snowflake/primary_connection.py +330 -0
- pulumi_snowflake/provider.py +433 -146
- pulumi_snowflake/pulumi-plugin.json +1 -1
- pulumi_snowflake/secondary_connection.py +339 -0
- pulumi_snowflake/secret_with_authorization_code_grant.py +548 -0
- pulumi_snowflake/secret_with_basic_authentication.py +500 -0
- pulumi_snowflake/secret_with_client_credentials.py +511 -0
- pulumi_snowflake/secret_with_generic_string.py +452 -0
- pulumi_snowflake/stream_on_directory_table.py +530 -0
- pulumi_snowflake/stream_on_external_table.py +50 -2
- pulumi_snowflake/stream_on_table.py +48 -0
- pulumi_snowflake/stream_on_view.py +679 -0
- pulumi_snowflake/tag_association.py +7 -7
- pulumi_snowflake/user.py +4 -0
- pulumi_snowflake/user_authentication_policy_attachment.py +197 -0
- {pulumi_snowflake-0.61.0a1731393894.dist-info → pulumi_snowflake-0.61.1.dist-info}/METADATA +1 -1
- {pulumi_snowflake-0.61.0a1731393894.dist-info → pulumi_snowflake-0.61.1.dist-info}/RECORD +39 -25
- {pulumi_snowflake-0.61.0a1731393894.dist-info → pulumi_snowflake-0.61.1.dist-info}/WHEEL +1 -1
- {pulumi_snowflake-0.61.0a1731393894.dist-info → pulumi_snowflake-0.61.1.dist-info}/top_level.txt +0 -0
|
@@ -17,17 +17,27 @@ from . import outputs
|
|
|
17
17
|
|
|
18
18
|
account: Optional[str]
|
|
19
19
|
"""
|
|
20
|
-
Specifies your Snowflake account identifier assigned, by Snowflake.
|
|
21
|
-
[
|
|
22
|
-
|
|
20
|
+
Use `account_name` and `organization_name` instead. Specifies your Snowflake account identifier assigned, by Snowflake.
|
|
21
|
+
The [account
|
|
22
|
+
locator](https://docs.snowflake.com/en/user-guide/admin-account-identifier#format-2-account-locator-in-a-region) format
|
|
23
|
+
is not supported. For information about account identifiers, see the [Snowflake
|
|
24
|
+
documentation](https://docs.snowflake.com/en/user-guide/admin-account-identifier.html). Required unless using `profile`.
|
|
25
|
+
Can also be sourced from the `SNOWFLAKE_ACCOUNT` environment variable.
|
|
26
|
+
"""
|
|
27
|
+
|
|
28
|
+
accountName: Optional[str]
|
|
29
|
+
"""
|
|
30
|
+
Specifies your Snowflake account name assigned by Snowflake. For information about account identifiers, see the
|
|
31
|
+
[Snowflake documentation](https://docs.snowflake.com/en/user-guide/admin-account-identifier#account-name). Required
|
|
32
|
+
unless using `profile`. Can also be sourced from the `SNOWFLAKE_ACCOUNT_NAME` environment variable.
|
|
23
33
|
"""
|
|
24
34
|
|
|
25
35
|
authenticator: Optional[str]
|
|
26
36
|
"""
|
|
27
37
|
Specifies the [authentication type](https://pkg.go.dev/github.com/snowflakedb/gosnowflake#AuthType) to use when
|
|
28
|
-
connecting to Snowflake. Valid
|
|
29
|
-
|
|
30
|
-
|
|
38
|
+
connecting to Snowflake. Valid options are: `SNOWFLAKE` | `OAUTH` | `EXTERNALBROWSER` | `OKTA` | `JWT` | `SNOWFLAKE_JWT`
|
|
39
|
+
| `TOKENACCESSOR` | `USERNAMEPASSWORDMFA`. Value `JWT` is deprecated and will be removed in future releases. Can also be
|
|
40
|
+
sourced from the `SNOWFLAKE_AUTHENTICATOR` environment variable.
|
|
31
41
|
"""
|
|
32
42
|
|
|
33
43
|
browserAuth: Optional[bool]
|
|
@@ -40,13 +50,13 @@ clientIp: Optional[str]
|
|
|
40
50
|
IP address for network checks. Can also be sourced from the `SNOWFLAKE_CLIENT_IP` environment variable.
|
|
41
51
|
"""
|
|
42
52
|
|
|
43
|
-
clientRequestMfaToken: Optional[
|
|
53
|
+
clientRequestMfaToken: Optional[str]
|
|
44
54
|
"""
|
|
45
55
|
When true the MFA token is cached in the credential manager. True by default in Windows/OSX. False for Linux. Can also
|
|
46
56
|
be sourced from the `SNOWFLAKE_CLIENT_REQUEST_MFA_TOKEN` environment variable.
|
|
47
57
|
"""
|
|
48
58
|
|
|
49
|
-
clientStoreTemporaryCredential: Optional[
|
|
59
|
+
clientStoreTemporaryCredential: Optional[str]
|
|
50
60
|
"""
|
|
51
61
|
When true the ID token is cached in the credential manager. True by default in Windows/OSX. False for Linux. Can also be
|
|
52
62
|
sourced from the `SNOWFLAKE_CLIENT_STORE_TEMPORARY_CREDENTIAL` environment variable.
|
|
@@ -54,31 +64,49 @@ sourced from the `SNOWFLAKE_CLIENT_STORE_TEMPORARY_CREDENTIAL` environment varia
|
|
|
54
64
|
|
|
55
65
|
clientTimeout: Optional[int]
|
|
56
66
|
"""
|
|
57
|
-
The timeout in seconds for the client to complete the authentication.
|
|
58
|
-
|
|
67
|
+
The timeout in seconds for the client to complete the authentication. Can also be sourced from the
|
|
68
|
+
`SNOWFLAKE_CLIENT_TIMEOUT` environment variable.
|
|
69
|
+
"""
|
|
70
|
+
|
|
71
|
+
disableConsoleLogin: Optional[str]
|
|
72
|
+
"""
|
|
73
|
+
Indicates whether console login should be disabled in the driver. Can also be sourced from the
|
|
74
|
+
`SNOWFLAKE_DISABLE_CONSOLE_LOGIN` environment variable.
|
|
59
75
|
"""
|
|
60
76
|
|
|
61
77
|
disableQueryContextCache: Optional[bool]
|
|
62
78
|
"""
|
|
63
|
-
|
|
79
|
+
Disables HTAP query context cache in the driver. Can also be sourced from the `SNOWFLAKE_DISABLE_QUERY_CONTEXT_CACHE`
|
|
64
80
|
environment variable.
|
|
65
81
|
"""
|
|
66
82
|
|
|
67
83
|
disableTelemetry: Optional[bool]
|
|
68
84
|
"""
|
|
69
|
-
|
|
85
|
+
Disables telemetry in the driver. Can also be sourced from the `DISABLE_TELEMETRY` environment variable.
|
|
86
|
+
"""
|
|
87
|
+
|
|
88
|
+
driverTracing: Optional[str]
|
|
89
|
+
"""
|
|
90
|
+
Specifies the logging level to be used by the driver. Valid options are: `trace` | `debug` | `info` | `print` |
|
|
91
|
+
`warning` | `error` | `fatal` | `panic`. Can also be sourced from the `SNOWFLAKE_DRIVER_TRACING` environment variable.
|
|
70
92
|
"""
|
|
71
93
|
|
|
72
94
|
externalBrowserTimeout: Optional[int]
|
|
73
95
|
"""
|
|
74
|
-
The timeout in seconds for the external browser to complete the authentication.
|
|
75
|
-
|
|
96
|
+
The timeout in seconds for the external browser to complete the authentication. Can also be sourced from the
|
|
97
|
+
`SNOWFLAKE_EXTERNAL_BROWSER_TIMEOUT` environment variable.
|
|
76
98
|
"""
|
|
77
99
|
|
|
78
100
|
host: Optional[str]
|
|
79
101
|
"""
|
|
80
|
-
|
|
81
|
-
|
|
102
|
+
Specifies a custom host value used by the driver for privatelink connections. Can also be sourced from the
|
|
103
|
+
`SNOWFLAKE_HOST` environment variable.
|
|
104
|
+
"""
|
|
105
|
+
|
|
106
|
+
includeRetryReason: Optional[str]
|
|
107
|
+
"""
|
|
108
|
+
Should retried request contain retry reason. Can also be sourced from the `SNOWFLAKE_INCLUDE_RETRY_REASON` environment
|
|
109
|
+
variable.
|
|
82
110
|
"""
|
|
83
111
|
|
|
84
112
|
insecureMode: Optional[bool]
|
|
@@ -90,8 +118,8 @@ environment variable.
|
|
|
90
118
|
|
|
91
119
|
jwtClientTimeout: Optional[int]
|
|
92
120
|
"""
|
|
93
|
-
The timeout in seconds for the JWT client to complete the authentication.
|
|
94
|
-
|
|
121
|
+
The timeout in seconds for the JWT client to complete the authentication. Can also be sourced from the
|
|
122
|
+
`SNOWFLAKE_JWT_CLIENT_TIMEOUT` environment variable.
|
|
95
123
|
"""
|
|
96
124
|
|
|
97
125
|
jwtExpireTimeout: Optional[int]
|
|
@@ -107,10 +135,16 @@ Enables the session to persist even after the connection is closed. Can also be
|
|
|
107
135
|
|
|
108
136
|
loginTimeout: Optional[int]
|
|
109
137
|
"""
|
|
110
|
-
Login retry timeout EXCLUDING network roundtrip and read out http response. Can also be sourced from the
|
|
138
|
+
Login retry timeout in seconds EXCLUDING network roundtrip and read out http response. Can also be sourced from the
|
|
111
139
|
`SNOWFLAKE_LOGIN_TIMEOUT` environment variable.
|
|
112
140
|
"""
|
|
113
141
|
|
|
142
|
+
maxRetryCount: Optional[int]
|
|
143
|
+
"""
|
|
144
|
+
Specifies how many times non-periodic HTTP request can be retried by the driver. Can also be sourced from the
|
|
145
|
+
`SNOWFLAKE_MAX_RETRY_COUNT` environment variable.
|
|
146
|
+
"""
|
|
147
|
+
|
|
114
148
|
oauthAccessToken: Optional[str]
|
|
115
149
|
"""
|
|
116
150
|
Token for use with OAuth. Generating the token is left to other tools. Cannot be used with `browser_auth`,
|
|
@@ -148,7 +182,7 @@ Token for use with OAuth. Setup and generation of the token is left to other too
|
|
|
148
182
|
environment variable.
|
|
149
183
|
"""
|
|
150
184
|
|
|
151
|
-
ocspFailOpen: Optional[
|
|
185
|
+
ocspFailOpen: Optional[str]
|
|
152
186
|
"""
|
|
153
187
|
True represents OCSP fail open mode. False represents OCSP fail closed mode. Fail open true by default. Can also be
|
|
154
188
|
sourced from the `SNOWFLAKE_OCSP_FAIL_OPEN` environment variable.
|
|
@@ -156,13 +190,22 @@ sourced from the `SNOWFLAKE_OCSP_FAIL_OPEN` environment variable.
|
|
|
156
190
|
|
|
157
191
|
oktaUrl: Optional[str]
|
|
158
192
|
"""
|
|
159
|
-
The URL of the Okta server. e.g. https://example.okta.com.
|
|
160
|
-
|
|
193
|
+
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
|
|
194
|
+
in Snowflake [docs](https://docs.snowflake.com/en/user-guide/oauth-okta). Can also be sourced from the
|
|
195
|
+
`SNOWFLAKE_OKTA_URL` environment variable.
|
|
196
|
+
"""
|
|
197
|
+
|
|
198
|
+
organizationName: Optional[str]
|
|
199
|
+
"""
|
|
200
|
+
Specifies your Snowflake organization name assigned by Snowflake. For information about account identifiers, see the
|
|
201
|
+
[Snowflake documentation](https://docs.snowflake.com/en/user-guide/admin-account-identifier#organization-name). Required
|
|
202
|
+
unless using `profile`. Can also be sourced from the `SNOWFLAKE_ORGANIZATION_NAME` environment variable.
|
|
161
203
|
"""
|
|
162
204
|
|
|
163
205
|
params: Optional[str]
|
|
164
206
|
"""
|
|
165
|
-
Sets other connection (i.e. session) parameters. [Parameters](https://docs.snowflake.com/en/sql-reference/parameters)
|
|
207
|
+
Sets other connection (i.e. session) parameters. [Parameters](https://docs.snowflake.com/en/sql-reference/parameters).
|
|
208
|
+
This field can not be set with environmental variables.
|
|
166
209
|
"""
|
|
167
210
|
|
|
168
211
|
passcode: Optional[str]
|
|
@@ -173,32 +216,32 @@ the `SNOWFLAKE_PASSCODE` environment variable.
|
|
|
173
216
|
|
|
174
217
|
passcodeInPassword: Optional[bool]
|
|
175
218
|
"""
|
|
176
|
-
False by default. Set to true if the MFA passcode is embedded
|
|
177
|
-
|
|
219
|
+
False by default. Set to true if the MFA passcode is embedded to the configured password. Can also be sourced from the
|
|
220
|
+
`SNOWFLAKE_PASSCODE_IN_PASSWORD` environment variable.
|
|
178
221
|
"""
|
|
179
222
|
|
|
180
223
|
password: Optional[str]
|
|
181
224
|
"""
|
|
182
|
-
Password for
|
|
225
|
+
Password for user + password auth. Cannot be used with `browser_auth` or `private_key_path`. Can also be sourced from
|
|
183
226
|
the `SNOWFLAKE_PASSWORD` environment variable.
|
|
184
227
|
"""
|
|
185
228
|
|
|
186
229
|
port: Optional[int]
|
|
187
230
|
"""
|
|
188
|
-
|
|
231
|
+
Specifies a custom port value used by the driver for privatelink connections. Can also be sourced from the
|
|
189
232
|
`SNOWFLAKE_PORT` environment variable.
|
|
190
233
|
"""
|
|
191
234
|
|
|
192
235
|
privateKey: Optional[str]
|
|
193
236
|
"""
|
|
194
237
|
Private Key for username+private-key auth. Cannot be used with `browser_auth` or `password`. Can also be sourced from
|
|
195
|
-
`SNOWFLAKE_PRIVATE_KEY` environment variable.
|
|
238
|
+
the `SNOWFLAKE_PRIVATE_KEY` environment variable.
|
|
196
239
|
"""
|
|
197
240
|
|
|
198
241
|
privateKeyPassphrase: Optional[str]
|
|
199
242
|
"""
|
|
200
243
|
Supports the encryption ciphers aes-128-cbc, aes-128-gcm, aes-192-cbc, aes-192-gcm, aes-256-cbc, aes-256-gcm, and
|
|
201
|
-
des-ede3-cbc. Can also be sourced from `SNOWFLAKE_PRIVATE_KEY_PASSPHRASE` environment variable.
|
|
244
|
+
des-ede3-cbc. Can also be sourced from the `SNOWFLAKE_PRIVATE_KEY_PASSPHRASE` environment variable.
|
|
202
245
|
"""
|
|
203
246
|
|
|
204
247
|
privateKeyPath: Optional[str]
|
|
@@ -215,7 +258,8 @@ variable.
|
|
|
215
258
|
|
|
216
259
|
protocol: Optional[str]
|
|
217
260
|
"""
|
|
218
|
-
|
|
261
|
+
A protocol used in the connection. Valid options are: `http` | `https`. Can also be sourced from the
|
|
262
|
+
`SNOWFLAKE_PROTOCOL` environment variable.
|
|
219
263
|
"""
|
|
220
264
|
|
|
221
265
|
region: Optional[str]
|
|
@@ -230,14 +274,14 @@ in the form of `<cloud_region_id>.<cloud>`. Can also be sourced from the `SNOWFL
|
|
|
230
274
|
|
|
231
275
|
requestTimeout: Optional[int]
|
|
232
276
|
"""
|
|
233
|
-
request retry timeout EXCLUDING network roundtrip and read out http response. Can also be sourced from the
|
|
277
|
+
request retry timeout in seconds EXCLUDING network roundtrip and read out http response. Can also be sourced from the
|
|
234
278
|
`SNOWFLAKE_REQUEST_TIMEOUT` environment variable.
|
|
235
279
|
"""
|
|
236
280
|
|
|
237
281
|
role: Optional[str]
|
|
238
282
|
"""
|
|
239
283
|
Specifies the role to use by default for accessing Snowflake objects in the client session. Can also be sourced from the
|
|
240
|
-
`SNOWFLAKE_ROLE` environment variable.
|
|
284
|
+
`SNOWFLAKE_ROLE` environment variable.
|
|
241
285
|
"""
|
|
242
286
|
|
|
243
287
|
sessionParams: Optional[str]
|
|
@@ -245,6 +289,12 @@ sessionParams: Optional[str]
|
|
|
245
289
|
Sets session parameters. [Parameters](https://docs.snowflake.com/en/sql-reference/parameters)
|
|
246
290
|
"""
|
|
247
291
|
|
|
292
|
+
tmpDirectoryPath: Optional[str]
|
|
293
|
+
"""
|
|
294
|
+
Sets temporary directory used by the driver for operations like encrypting, compressing etc. Can also be sourced from
|
|
295
|
+
the `SNOWFLAKE_TMP_DIRECTORY_PATH` environment variable.
|
|
296
|
+
"""
|
|
297
|
+
|
|
248
298
|
token: Optional[str]
|
|
249
299
|
"""
|
|
250
300
|
Token to use for OAuth and other forms of token based auth. Can also be sourced from the `SNOWFLAKE_TOKEN` environment
|
|
@@ -255,16 +305,16 @@ tokenAccessor: Optional[str]
|
|
|
255
305
|
|
|
256
306
|
user: Optional[str]
|
|
257
307
|
"""
|
|
258
|
-
Username. Can also be sourced from the `SNOWFLAKE_USER` environment variable.
|
|
308
|
+
Username. Required unless using `profile`. Can also be sourced from the `SNOWFLAKE_USER` environment variable.
|
|
259
309
|
"""
|
|
260
310
|
|
|
261
311
|
username: Optional[str]
|
|
262
312
|
"""
|
|
263
|
-
Username for
|
|
264
|
-
|
|
313
|
+
Username for user + password authentication. Required unless using `profile`. Can also be sourced from the
|
|
314
|
+
`SNOWFLAKE_USERNAME` environment variable.
|
|
265
315
|
"""
|
|
266
316
|
|
|
267
|
-
validateDefaultParameters: Optional[
|
|
317
|
+
validateDefaultParameters: Optional[str]
|
|
268
318
|
"""
|
|
269
319
|
True by default. If false, disables the validation checks for Database, Schema, Warehouse and Role at the time a
|
|
270
320
|
connection is established. Can also be sourced from the `SNOWFLAKE_VALIDATE_DEFAULT_PARAMETERS` environment variable.
|
pulumi_snowflake/config/vars.py
CHANGED
|
@@ -24,19 +24,31 @@ class _ExportableConfig(types.ModuleType):
|
|
|
24
24
|
@property
|
|
25
25
|
def account(self) -> Optional[str]:
|
|
26
26
|
"""
|
|
27
|
-
Specifies your Snowflake account identifier assigned, by Snowflake.
|
|
28
|
-
[
|
|
29
|
-
|
|
27
|
+
Use `account_name` and `organization_name` instead. Specifies your Snowflake account identifier assigned, by Snowflake.
|
|
28
|
+
The [account
|
|
29
|
+
locator](https://docs.snowflake.com/en/user-guide/admin-account-identifier#format-2-account-locator-in-a-region) format
|
|
30
|
+
is not supported. For information about account identifiers, see the [Snowflake
|
|
31
|
+
documentation](https://docs.snowflake.com/en/user-guide/admin-account-identifier.html). Required unless using `profile`.
|
|
32
|
+
Can also be sourced from the `SNOWFLAKE_ACCOUNT` environment variable.
|
|
30
33
|
"""
|
|
31
34
|
return __config__.get('account') or _utilities.get_env('SNOWFLAKE_ACCOUNT')
|
|
32
35
|
|
|
36
|
+
@property
|
|
37
|
+
def account_name(self) -> Optional[str]:
|
|
38
|
+
"""
|
|
39
|
+
Specifies your Snowflake account name assigned by Snowflake. For information about account identifiers, see the
|
|
40
|
+
[Snowflake documentation](https://docs.snowflake.com/en/user-guide/admin-account-identifier#account-name). Required
|
|
41
|
+
unless using `profile`. Can also be sourced from the `SNOWFLAKE_ACCOUNT_NAME` environment variable.
|
|
42
|
+
"""
|
|
43
|
+
return __config__.get('accountName')
|
|
44
|
+
|
|
33
45
|
@property
|
|
34
46
|
def authenticator(self) -> Optional[str]:
|
|
35
47
|
"""
|
|
36
48
|
Specifies the [authentication type](https://pkg.go.dev/github.com/snowflakedb/gosnowflake#AuthType) to use when
|
|
37
|
-
connecting to Snowflake. Valid
|
|
38
|
-
|
|
39
|
-
|
|
49
|
+
connecting to Snowflake. Valid options are: `SNOWFLAKE` | `OAUTH` | `EXTERNALBROWSER` | `OKTA` | `JWT` | `SNOWFLAKE_JWT`
|
|
50
|
+
| `TOKENACCESSOR` | `USERNAMEPASSWORDMFA`. Value `JWT` is deprecated and will be removed in future releases. Can also be
|
|
51
|
+
sourced from the `SNOWFLAKE_AUTHENTICATOR` environment variable.
|
|
40
52
|
"""
|
|
41
53
|
return __config__.get('authenticator')
|
|
42
54
|
|
|
@@ -55,33 +67,41 @@ class _ExportableConfig(types.ModuleType):
|
|
|
55
67
|
return __config__.get('clientIp')
|
|
56
68
|
|
|
57
69
|
@property
|
|
58
|
-
def client_request_mfa_token(self) -> Optional[
|
|
70
|
+
def client_request_mfa_token(self) -> Optional[str]:
|
|
59
71
|
"""
|
|
60
72
|
When true the MFA token is cached in the credential manager. True by default in Windows/OSX. False for Linux. Can also
|
|
61
73
|
be sourced from the `SNOWFLAKE_CLIENT_REQUEST_MFA_TOKEN` environment variable.
|
|
62
74
|
"""
|
|
63
|
-
return __config__.
|
|
75
|
+
return __config__.get('clientRequestMfaToken')
|
|
64
76
|
|
|
65
77
|
@property
|
|
66
|
-
def client_store_temporary_credential(self) -> Optional[
|
|
78
|
+
def client_store_temporary_credential(self) -> Optional[str]:
|
|
67
79
|
"""
|
|
68
80
|
When true the ID token is cached in the credential manager. True by default in Windows/OSX. False for Linux. Can also be
|
|
69
81
|
sourced from the `SNOWFLAKE_CLIENT_STORE_TEMPORARY_CREDENTIAL` environment variable.
|
|
70
82
|
"""
|
|
71
|
-
return __config__.
|
|
83
|
+
return __config__.get('clientStoreTemporaryCredential')
|
|
72
84
|
|
|
73
85
|
@property
|
|
74
86
|
def client_timeout(self) -> Optional[int]:
|
|
75
87
|
"""
|
|
76
|
-
The timeout in seconds for the client to complete the authentication.
|
|
77
|
-
|
|
88
|
+
The timeout in seconds for the client to complete the authentication. Can also be sourced from the
|
|
89
|
+
`SNOWFLAKE_CLIENT_TIMEOUT` environment variable.
|
|
78
90
|
"""
|
|
79
91
|
return __config__.get_int('clientTimeout')
|
|
80
92
|
|
|
93
|
+
@property
|
|
94
|
+
def disable_console_login(self) -> Optional[str]:
|
|
95
|
+
"""
|
|
96
|
+
Indicates whether console login should be disabled in the driver. Can also be sourced from the
|
|
97
|
+
`SNOWFLAKE_DISABLE_CONSOLE_LOGIN` environment variable.
|
|
98
|
+
"""
|
|
99
|
+
return __config__.get('disableConsoleLogin')
|
|
100
|
+
|
|
81
101
|
@property
|
|
82
102
|
def disable_query_context_cache(self) -> Optional[bool]:
|
|
83
103
|
"""
|
|
84
|
-
|
|
104
|
+
Disables HTAP query context cache in the driver. Can also be sourced from the `SNOWFLAKE_DISABLE_QUERY_CONTEXT_CACHE`
|
|
85
105
|
environment variable.
|
|
86
106
|
"""
|
|
87
107
|
return __config__.get_bool('disableQueryContextCache')
|
|
@@ -89,26 +109,42 @@ class _ExportableConfig(types.ModuleType):
|
|
|
89
109
|
@property
|
|
90
110
|
def disable_telemetry(self) -> Optional[bool]:
|
|
91
111
|
"""
|
|
92
|
-
|
|
112
|
+
Disables telemetry in the driver. Can also be sourced from the `DISABLE_TELEMETRY` environment variable.
|
|
93
113
|
"""
|
|
94
114
|
return __config__.get_bool('disableTelemetry')
|
|
95
115
|
|
|
116
|
+
@property
|
|
117
|
+
def driver_tracing(self) -> Optional[str]:
|
|
118
|
+
"""
|
|
119
|
+
Specifies the logging level to be used by the driver. Valid options are: `trace` | `debug` | `info` | `print` |
|
|
120
|
+
`warning` | `error` | `fatal` | `panic`. Can also be sourced from the `SNOWFLAKE_DRIVER_TRACING` environment variable.
|
|
121
|
+
"""
|
|
122
|
+
return __config__.get('driverTracing')
|
|
123
|
+
|
|
96
124
|
@property
|
|
97
125
|
def external_browser_timeout(self) -> Optional[int]:
|
|
98
126
|
"""
|
|
99
|
-
The timeout in seconds for the external browser to complete the authentication.
|
|
100
|
-
|
|
127
|
+
The timeout in seconds for the external browser to complete the authentication. Can also be sourced from the
|
|
128
|
+
`SNOWFLAKE_EXTERNAL_BROWSER_TIMEOUT` environment variable.
|
|
101
129
|
"""
|
|
102
130
|
return __config__.get_int('externalBrowserTimeout')
|
|
103
131
|
|
|
104
132
|
@property
|
|
105
133
|
def host(self) -> Optional[str]:
|
|
106
134
|
"""
|
|
107
|
-
|
|
108
|
-
|
|
135
|
+
Specifies a custom host value used by the driver for privatelink connections. Can also be sourced from the
|
|
136
|
+
`SNOWFLAKE_HOST` environment variable.
|
|
109
137
|
"""
|
|
110
138
|
return __config__.get('host') or _utilities.get_env('SNOWFLAKE_HOST')
|
|
111
139
|
|
|
140
|
+
@property
|
|
141
|
+
def include_retry_reason(self) -> Optional[str]:
|
|
142
|
+
"""
|
|
143
|
+
Should retried request contain retry reason. Can also be sourced from the `SNOWFLAKE_INCLUDE_RETRY_REASON` environment
|
|
144
|
+
variable.
|
|
145
|
+
"""
|
|
146
|
+
return __config__.get('includeRetryReason')
|
|
147
|
+
|
|
112
148
|
@property
|
|
113
149
|
def insecure_mode(self) -> Optional[bool]:
|
|
114
150
|
"""
|
|
@@ -121,8 +157,8 @@ class _ExportableConfig(types.ModuleType):
|
|
|
121
157
|
@property
|
|
122
158
|
def jwt_client_timeout(self) -> Optional[int]:
|
|
123
159
|
"""
|
|
124
|
-
The timeout in seconds for the JWT client to complete the authentication.
|
|
125
|
-
|
|
160
|
+
The timeout in seconds for the JWT client to complete the authentication. Can also be sourced from the
|
|
161
|
+
`SNOWFLAKE_JWT_CLIENT_TIMEOUT` environment variable.
|
|
126
162
|
"""
|
|
127
163
|
return __config__.get_int('jwtClientTimeout')
|
|
128
164
|
|
|
@@ -144,11 +180,19 @@ class _ExportableConfig(types.ModuleType):
|
|
|
144
180
|
@property
|
|
145
181
|
def login_timeout(self) -> Optional[int]:
|
|
146
182
|
"""
|
|
147
|
-
Login retry timeout EXCLUDING network roundtrip and read out http response. Can also be sourced from the
|
|
183
|
+
Login retry timeout in seconds EXCLUDING network roundtrip and read out http response. Can also be sourced from the
|
|
148
184
|
`SNOWFLAKE_LOGIN_TIMEOUT` environment variable.
|
|
149
185
|
"""
|
|
150
186
|
return __config__.get_int('loginTimeout')
|
|
151
187
|
|
|
188
|
+
@property
|
|
189
|
+
def max_retry_count(self) -> Optional[int]:
|
|
190
|
+
"""
|
|
191
|
+
Specifies how many times non-periodic HTTP request can be retried by the driver. Can also be sourced from the
|
|
192
|
+
`SNOWFLAKE_MAX_RETRY_COUNT` environment variable.
|
|
193
|
+
"""
|
|
194
|
+
return __config__.get_int('maxRetryCount')
|
|
195
|
+
|
|
152
196
|
@property
|
|
153
197
|
def oauth_access_token(self) -> Optional[str]:
|
|
154
198
|
"""
|
|
@@ -199,25 +243,36 @@ class _ExportableConfig(types.ModuleType):
|
|
|
199
243
|
return __config__.get('oauthRefreshToken') or _utilities.get_env('SNOWFLAKE_OAUTH_REFRESH_TOKEN')
|
|
200
244
|
|
|
201
245
|
@property
|
|
202
|
-
def ocsp_fail_open(self) -> Optional[
|
|
246
|
+
def ocsp_fail_open(self) -> Optional[str]:
|
|
203
247
|
"""
|
|
204
248
|
True represents OCSP fail open mode. False represents OCSP fail closed mode. Fail open true by default. Can also be
|
|
205
249
|
sourced from the `SNOWFLAKE_OCSP_FAIL_OPEN` environment variable.
|
|
206
250
|
"""
|
|
207
|
-
return __config__.
|
|
251
|
+
return __config__.get('ocspFailOpen')
|
|
208
252
|
|
|
209
253
|
@property
|
|
210
254
|
def okta_url(self) -> Optional[str]:
|
|
211
255
|
"""
|
|
212
|
-
The URL of the Okta server. e.g. https://example.okta.com.
|
|
213
|
-
|
|
256
|
+
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
|
|
257
|
+
in Snowflake [docs](https://docs.snowflake.com/en/user-guide/oauth-okta). Can also be sourced from the
|
|
258
|
+
`SNOWFLAKE_OKTA_URL` environment variable.
|
|
214
259
|
"""
|
|
215
260
|
return __config__.get('oktaUrl')
|
|
216
261
|
|
|
262
|
+
@property
|
|
263
|
+
def organization_name(self) -> Optional[str]:
|
|
264
|
+
"""
|
|
265
|
+
Specifies your Snowflake organization name assigned by Snowflake. For information about account identifiers, see the
|
|
266
|
+
[Snowflake documentation](https://docs.snowflake.com/en/user-guide/admin-account-identifier#organization-name). Required
|
|
267
|
+
unless using `profile`. Can also be sourced from the `SNOWFLAKE_ORGANIZATION_NAME` environment variable.
|
|
268
|
+
"""
|
|
269
|
+
return __config__.get('organizationName')
|
|
270
|
+
|
|
217
271
|
@property
|
|
218
272
|
def params(self) -> Optional[str]:
|
|
219
273
|
"""
|
|
220
|
-
Sets other connection (i.e. session) parameters. [Parameters](https://docs.snowflake.com/en/sql-reference/parameters)
|
|
274
|
+
Sets other connection (i.e. session) parameters. [Parameters](https://docs.snowflake.com/en/sql-reference/parameters).
|
|
275
|
+
This field can not be set with environmental variables.
|
|
221
276
|
"""
|
|
222
277
|
return __config__.get('params')
|
|
223
278
|
|
|
@@ -232,15 +287,15 @@ class _ExportableConfig(types.ModuleType):
|
|
|
232
287
|
@property
|
|
233
288
|
def passcode_in_password(self) -> Optional[bool]:
|
|
234
289
|
"""
|
|
235
|
-
False by default. Set to true if the MFA passcode is embedded
|
|
236
|
-
|
|
290
|
+
False by default. Set to true if the MFA passcode is embedded to the configured password. Can also be sourced from the
|
|
291
|
+
`SNOWFLAKE_PASSCODE_IN_PASSWORD` environment variable.
|
|
237
292
|
"""
|
|
238
293
|
return __config__.get_bool('passcodeInPassword')
|
|
239
294
|
|
|
240
295
|
@property
|
|
241
296
|
def password(self) -> Optional[str]:
|
|
242
297
|
"""
|
|
243
|
-
Password for
|
|
298
|
+
Password for user + password auth. Cannot be used with `browser_auth` or `private_key_path`. Can also be sourced from
|
|
244
299
|
the `SNOWFLAKE_PASSWORD` environment variable.
|
|
245
300
|
"""
|
|
246
301
|
return __config__.get('password') or _utilities.get_env('SNOWFLAKE_PASSWORD')
|
|
@@ -248,7 +303,7 @@ class _ExportableConfig(types.ModuleType):
|
|
|
248
303
|
@property
|
|
249
304
|
def port(self) -> Optional[int]:
|
|
250
305
|
"""
|
|
251
|
-
|
|
306
|
+
Specifies a custom port value used by the driver for privatelink connections. Can also be sourced from the
|
|
252
307
|
`SNOWFLAKE_PORT` environment variable.
|
|
253
308
|
"""
|
|
254
309
|
return __config__.get_int('port') or _utilities.get_env_int('SNOWFLAKE_PORT')
|
|
@@ -257,7 +312,7 @@ class _ExportableConfig(types.ModuleType):
|
|
|
257
312
|
def private_key(self) -> Optional[str]:
|
|
258
313
|
"""
|
|
259
314
|
Private Key for username+private-key auth. Cannot be used with `browser_auth` or `password`. Can also be sourced from
|
|
260
|
-
`SNOWFLAKE_PRIVATE_KEY` environment variable.
|
|
315
|
+
the `SNOWFLAKE_PRIVATE_KEY` environment variable.
|
|
261
316
|
"""
|
|
262
317
|
return __config__.get('privateKey')
|
|
263
318
|
|
|
@@ -265,7 +320,7 @@ class _ExportableConfig(types.ModuleType):
|
|
|
265
320
|
def private_key_passphrase(self) -> Optional[str]:
|
|
266
321
|
"""
|
|
267
322
|
Supports the encryption ciphers aes-128-cbc, aes-128-gcm, aes-192-cbc, aes-192-gcm, aes-256-cbc, aes-256-gcm, and
|
|
268
|
-
des-ede3-cbc. Can also be sourced from `SNOWFLAKE_PRIVATE_KEY_PASSPHRASE` environment variable.
|
|
323
|
+
des-ede3-cbc. Can also be sourced from the `SNOWFLAKE_PRIVATE_KEY_PASSPHRASE` environment variable.
|
|
269
324
|
"""
|
|
270
325
|
return __config__.get('privateKeyPassphrase') or _utilities.get_env('SNOWFLAKE_PRIVATE_KEY_PASSPHRASE')
|
|
271
326
|
|
|
@@ -288,7 +343,8 @@ class _ExportableConfig(types.ModuleType):
|
|
|
288
343
|
@property
|
|
289
344
|
def protocol(self) -> Optional[str]:
|
|
290
345
|
"""
|
|
291
|
-
|
|
346
|
+
A protocol used in the connection. Valid options are: `http` | `https`. Can also be sourced from the
|
|
347
|
+
`SNOWFLAKE_PROTOCOL` environment variable.
|
|
292
348
|
"""
|
|
293
349
|
return __config__.get('protocol') or _utilities.get_env('SNOWFLAKE_PROTOCOL')
|
|
294
350
|
|
|
@@ -307,7 +363,7 @@ class _ExportableConfig(types.ModuleType):
|
|
|
307
363
|
@property
|
|
308
364
|
def request_timeout(self) -> Optional[int]:
|
|
309
365
|
"""
|
|
310
|
-
request retry timeout EXCLUDING network roundtrip and read out http response. Can also be sourced from the
|
|
366
|
+
request retry timeout in seconds EXCLUDING network roundtrip and read out http response. Can also be sourced from the
|
|
311
367
|
`SNOWFLAKE_REQUEST_TIMEOUT` environment variable.
|
|
312
368
|
"""
|
|
313
369
|
return __config__.get_int('requestTimeout')
|
|
@@ -316,7 +372,7 @@ class _ExportableConfig(types.ModuleType):
|
|
|
316
372
|
def role(self) -> Optional[str]:
|
|
317
373
|
"""
|
|
318
374
|
Specifies the role to use by default for accessing Snowflake objects in the client session. Can also be sourced from the
|
|
319
|
-
`SNOWFLAKE_ROLE` environment variable.
|
|
375
|
+
`SNOWFLAKE_ROLE` environment variable.
|
|
320
376
|
"""
|
|
321
377
|
return __config__.get('role') or _utilities.get_env('SNOWFLAKE_ROLE')
|
|
322
378
|
|
|
@@ -327,6 +383,14 @@ class _ExportableConfig(types.ModuleType):
|
|
|
327
383
|
"""
|
|
328
384
|
return __config__.get('sessionParams')
|
|
329
385
|
|
|
386
|
+
@property
|
|
387
|
+
def tmp_directory_path(self) -> Optional[str]:
|
|
388
|
+
"""
|
|
389
|
+
Sets temporary directory used by the driver for operations like encrypting, compressing etc. Can also be sourced from
|
|
390
|
+
the `SNOWFLAKE_TMP_DIRECTORY_PATH` environment variable.
|
|
391
|
+
"""
|
|
392
|
+
return __config__.get('tmpDirectoryPath')
|
|
393
|
+
|
|
330
394
|
@property
|
|
331
395
|
def token(self) -> Optional[str]:
|
|
332
396
|
"""
|
|
@@ -342,25 +406,25 @@ class _ExportableConfig(types.ModuleType):
|
|
|
342
406
|
@property
|
|
343
407
|
def user(self) -> Optional[str]:
|
|
344
408
|
"""
|
|
345
|
-
Username. Can also be sourced from the `SNOWFLAKE_USER` environment variable.
|
|
409
|
+
Username. Required unless using `profile`. Can also be sourced from the `SNOWFLAKE_USER` environment variable.
|
|
346
410
|
"""
|
|
347
411
|
return __config__.get('user')
|
|
348
412
|
|
|
349
413
|
@property
|
|
350
414
|
def username(self) -> Optional[str]:
|
|
351
415
|
"""
|
|
352
|
-
Username for
|
|
353
|
-
|
|
416
|
+
Username for user + password authentication. Required unless using `profile`. Can also be sourced from the
|
|
417
|
+
`SNOWFLAKE_USERNAME` environment variable.
|
|
354
418
|
"""
|
|
355
419
|
return __config__.get('username') or _utilities.get_env('SNOWFLAKE_USER')
|
|
356
420
|
|
|
357
421
|
@property
|
|
358
|
-
def validate_default_parameters(self) -> Optional[
|
|
422
|
+
def validate_default_parameters(self) -> Optional[str]:
|
|
359
423
|
"""
|
|
360
424
|
True by default. If false, disables the validation checks for Database, Schema, Warehouse and Role at the time a
|
|
361
425
|
connection is established. Can also be sourced from the `SNOWFLAKE_VALIDATE_DEFAULT_PARAMETERS` environment variable.
|
|
362
426
|
"""
|
|
363
|
-
return __config__.
|
|
427
|
+
return __config__.get('validateDefaultParameters')
|
|
364
428
|
|
|
365
429
|
@property
|
|
366
430
|
def warehouse(self) -> Optional[str]:
|