This repository has been archived by the owner on Apr 26, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 11
/
database.py
790 lines (697 loc) · 29.4 KB
/
database.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
"""Module for querying against Snowflake databases."""
import asyncio
from typing import Any, Dict, List, Optional, Tuple, Type, Union
from prefect import task
from prefect.blocks.abstract import DatabaseBlock
from prefect.utilities.asyncutils import run_sync_in_worker_thread, sync_compatible
from prefect.utilities.hashing import hash_objects
from pydantic import VERSION as PYDANTIC_VERSION
if PYDANTIC_VERSION.startswith("2."):
from pydantic.v1 import Field
else:
from pydantic import Field
from snowflake.connector.connection import SnowflakeConnection
from snowflake.connector.cursor import SnowflakeCursor
from prefect_snowflake import SnowflakeCredentials
BEGIN_TRANSACTION_STATEMENT = "BEGIN TRANSACTION"
END_TRANSACTION_STATEMENT = "COMMIT"
class SnowflakeConnector(DatabaseBlock):
"""
Block used to manage connections with Snowflake.
Upon instantiating, a connection is created and maintained for the life of
the object until the close method is called.
It is recommended to use this block as a context manager, which will automatically
close the engine and its connections when the context is exited.
It is also recommended that this block is loaded and consumed within a single task
or flow because if the block is passed across separate tasks and flows,
the state of the block's connection and cursor will be lost.
Args:
credentials: The credentials to authenticate with Snowflake.
database: The name of the default database to use.
warehouse: The name of the default warehouse to use.
schema: The name of the default schema to use;
this attribute is accessible through `SnowflakeConnector(...).schema_`.
fetch_size: The number of rows to fetch at a time.
poll_frequency_s: The number of seconds before checking query.
Examples:
Load stored Snowflake connector as a context manager:
```python
from prefect_snowflake.database import SnowflakeConnector
snowflake_connector = SnowflakeConnector.load("BLOCK_NAME"):
```
Insert data into database and fetch results.
```python
from prefect_snowflake.database import SnowflakeConnector
with SnowflakeConnector.load("BLOCK_NAME") as conn:
conn.execute(
"CREATE TABLE IF NOT EXISTS customers (name varchar, address varchar);"
)
conn.execute_many(
"INSERT INTO customers (name, address) VALUES (%(name)s, %(address)s);",
seq_of_parameters=[
{"name": "Ford", "address": "Highway 42"},
{"name": "Unknown", "address": "Space"},
{"name": "Me", "address": "Myway 88"},
],
)
results = conn.fetch_all(
"SELECT * FROM customers WHERE address = %(address)s",
parameters={"address": "Space"}
)
print(results)
```
""" # noqa
_block_type_name = "Snowflake Connector"
_logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/bd359de0b4be76c2254bd329fe3a267a1a3879c2-250x250.png" # noqa
_documentation_url = "https://prefecthq.github.io/prefect-snowflake/database/#prefect_snowflake.database.SnowflakeConnector" # noqa
_description = "Perform data operations against a Snowflake database."
credentials: SnowflakeCredentials = Field(
default=..., description="The credentials to authenticate with Snowflake."
)
database: str = Field(
default=..., description="The name of the default database to use."
)
warehouse: str = Field(
default=..., description="The name of the default warehouse to use."
)
schema_: str = Field(
default=...,
alias="schema",
description="The name of the default schema to use.",
)
fetch_size: int = Field(
default=1, description="The default number of rows to fetch at a time."
)
poll_frequency_s: int = Field(
default=1,
title="Poll Frequency [seconds]",
description=(
"The number of seconds between checking query "
"status for long running queries."
),
)
_connection: Optional[SnowflakeConnection] = None
_unique_cursors: Dict[str, SnowflakeCursor] = None
def get_connection(self, **connect_kwargs: Any) -> SnowflakeConnection:
"""
Returns an authenticated connection that can be
used to query from Snowflake databases.
Args:
**connect_kwargs: Additional arguments to pass to
`snowflake.connector.connect`.
Returns:
The authenticated SnowflakeConnection.
Examples:
```python
from prefect_snowflake.credentials import SnowflakeCredentials
from prefect_snowflake.database import SnowflakeConnector
snowflake_credentials = SnowflakeCredentials(
account="account",
user="user",
password="password",
)
snowflake_connector = SnowflakeConnector(
database="database",
warehouse="warehouse",
schema="schema",
credentials=snowflake_credentials
)
with snowflake_connector.get_connection() as connection:
...
```
"""
if self._connection is not None:
return self._connection
connect_params = {
"database": self.database,
"warehouse": self.warehouse,
"schema": self.schema_,
}
connection = self.credentials.get_client(**connect_kwargs, **connect_params)
self._connection = connection
self.logger.info("Started a new connection to Snowflake.")
return connection
def _start_connection(self):
"""
Starts Snowflake database connection.
"""
self.get_connection()
if self._unique_cursors is None:
self._unique_cursors = {}
def _get_cursor(
self,
inputs: Dict[str, Any],
cursor_type: Type[SnowflakeCursor] = SnowflakeCursor,
) -> Tuple[bool, SnowflakeCursor]:
"""
Get a Snowflake cursor.
Args:
inputs: The inputs to generate a unique hash, used to decide
whether a new cursor should be used.
cursor_type: The class of the cursor to use when creating a
Snowflake cursor.
Returns:
Whether a cursor is new and a Snowflake cursor.
"""
self._start_connection()
input_hash = hash_objects(inputs)
if input_hash is None:
raise RuntimeError(
"We were not able to hash your inputs, "
"which resulted in an unexpected data return; "
"please open an issue with a reproducible example."
)
if input_hash not in self._unique_cursors.keys():
new_cursor = self._connection.cursor(cursor_type)
self._unique_cursors[input_hash] = new_cursor
return True, new_cursor
else:
existing_cursor = self._unique_cursors[input_hash]
return False, existing_cursor
async def _execute_async(self, cursor: SnowflakeCursor, inputs: Dict[str, Any]):
"""Helper method to execute operations asynchronously."""
response = await run_sync_in_worker_thread(cursor.execute_async, **inputs)
self.logger.info(
f"Executing the operation, {inputs['command']!r}, asynchronously; "
f"polling for the result every {self.poll_frequency_s} seconds."
)
query_id = response["queryId"]
while self._connection.is_still_running(
await run_sync_in_worker_thread(
self._connection.get_query_status_throw_if_error, query_id
)
):
await asyncio.sleep(self.poll_frequency_s)
await run_sync_in_worker_thread(cursor.get_results_from_sfqid, query_id)
def reset_cursors(self) -> None:
"""
Tries to close all opened cursors.
Examples:
Reset the cursors to refresh cursor position.
```python
from prefect_snowflake.database import SnowflakeConnector
with SnowflakeConnector.load("BLOCK_NAME") as conn:
conn.execute(
"CREATE TABLE IF NOT EXISTS customers (name varchar, address varchar);"
)
conn.execute_many(
"INSERT INTO customers (name, address) VALUES (%(name)s, %(address)s);",
seq_of_parameters=[
{"name": "Ford", "address": "Highway 42"},
{"name": "Unknown", "address": "Space"},
{"name": "Me", "address": "Myway 88"},
],
)
print(conn.fetch_one("SELECT * FROM customers")) # Ford
conn.reset_cursors()
print(conn.fetch_one("SELECT * FROM customers")) # should be Ford again
```
""" # noqa
if not self._unique_cursors:
self.logger.info("There were no cursors to reset.")
return
input_hashes = tuple(self._unique_cursors.keys())
for input_hash in input_hashes:
cursor = self._unique_cursors.pop(input_hash)
try:
cursor.close()
except Exception as exc:
self.logger.warning(
f"Failed to close cursor for input hash {input_hash!r}: {exc}"
)
self.logger.info("Successfully reset the cursors.")
@sync_compatible
async def fetch_one(
self,
operation: str,
parameters: Optional[Dict[str, Any]] = None,
cursor_type: Type[SnowflakeCursor] = SnowflakeCursor,
**execute_kwargs: Any,
) -> Tuple[Any]:
"""
Fetch a single result from the database.
Repeated calls using the same inputs to *any* of the fetch methods of this
block will skip executing the operation again, and instead,
return the next set of results from the previous execution,
until the reset_cursors method is called.
Args:
operation: The SQL query or other operation to be executed.
parameters: The parameters for the operation.
cursor_type: The class of the cursor to use when creating a Snowflake cursor.
**execute_kwargs: Additional options to pass to `cursor.execute_async`.
Returns:
A tuple containing the data returned by the database,
where each row is a tuple and each column is a value in the tuple.
Examples:
Fetch one row from the database where address is Space.
```python
from prefect_snowflake.database import SnowflakeConnector
with SnowflakeConnector.load("BLOCK_NAME") as conn:
conn.execute(
"CREATE TABLE IF NOT EXISTS customers (name varchar, address varchar);"
)
conn.execute_many(
"INSERT INTO customers (name, address) VALUES (%(name)s, %(address)s);",
seq_of_parameters=[
{"name": "Ford", "address": "Highway 42"},
{"name": "Unknown", "address": "Space"},
{"name": "Me", "address": "Myway 88"},
],
)
result = conn.fetch_one(
"SELECT * FROM customers WHERE address = %(address)s",
parameters={"address": "Space"}
)
print(result)
```
""" # noqa
inputs = dict(
command=operation,
params=parameters,
**execute_kwargs,
)
new, cursor = self._get_cursor(inputs, cursor_type=cursor_type)
if new:
await self._execute_async(cursor, inputs)
self.logger.debug("Preparing to fetch a row.")
result = await run_sync_in_worker_thread(cursor.fetchone)
return result
@sync_compatible
async def fetch_many(
self,
operation: str,
parameters: Optional[Dict[str, Any]] = None,
size: Optional[int] = None,
cursor_type: Type[SnowflakeCursor] = SnowflakeCursor,
**execute_kwargs: Any,
) -> List[Tuple[Any]]:
"""
Fetch a limited number of results from the database.
Repeated calls using the same inputs to *any* of the fetch methods of this
block will skip executing the operation again, and instead,
return the next set of results from the previous execution,
until the reset_cursors method is called.
Args:
operation: The SQL query or other operation to be executed.
parameters: The parameters for the operation.
size: The number of results to return; if None or 0, uses the value of
`fetch_size` configured on the block.
cursor_type: The class of the cursor to use when creating a Snowflake cursor.
**execute_kwargs: Additional options to pass to `cursor.execute_async`.
Returns:
A list of tuples containing the data returned by the database,
where each row is a tuple and each column is a value in the tuple.
Examples:
Repeatedly fetch two rows from the database where address is Highway 42.
```python
from prefect_snowflake.database import SnowflakeConnector
with SnowflakeConnector.load("BLOCK_NAME") as conn:
conn.execute(
"CREATE TABLE IF NOT EXISTS customers (name varchar, address varchar);"
)
conn.execute_many(
"INSERT INTO customers (name, address) VALUES (%(name)s, %(address)s);",
seq_of_parameters=[
{"name": "Marvin", "address": "Highway 42"},
{"name": "Ford", "address": "Highway 42"},
{"name": "Unknown", "address": "Highway 42"},
{"name": "Me", "address": "Highway 42"},
],
)
result = conn.fetch_many(
"SELECT * FROM customers WHERE address = %(address)s",
parameters={"address": "Highway 42"},
size=2
)
print(result) # Marvin, Ford
result = conn.fetch_many(
"SELECT * FROM customers WHERE address = %(address)s",
parameters={"address": "Highway 42"},
size=2
)
print(result) # Unknown, Me
```
""" # noqa
inputs = dict(
command=operation,
params=parameters,
**execute_kwargs,
)
new, cursor = self._get_cursor(inputs, cursor_type)
if new:
await self._execute_async(cursor, inputs)
size = size or self.fetch_size
self.logger.debug(f"Preparing to fetch {size} rows.")
result = await run_sync_in_worker_thread(cursor.fetchmany, size=size)
return result
@sync_compatible
async def fetch_all(
self,
operation: str,
parameters: Optional[Dict[str, Any]] = None,
cursor_type: Type[SnowflakeCursor] = SnowflakeCursor,
**execute_kwargs: Any,
) -> List[Tuple[Any]]:
"""
Fetch all results from the database.
Repeated calls using the same inputs to *any* of the fetch methods of this
block will skip executing the operation again, and instead,
return the next set of results from the previous execution,
until the reset_cursors method is called.
Args:
operation: The SQL query or other operation to be executed.
parameters: The parameters for the operation.
cursor_type: The class of the cursor to use when creating a Snowflake cursor.
**execute_kwargs: Additional options to pass to `cursor.execute_async`.
Returns:
A list of tuples containing the data returned by the database,
where each row is a tuple and each column is a value in the tuple.
Examples:
Fetch all rows from the database where address is Highway 42.
```python
from prefect_snowflake.database import SnowflakeConnector
with SnowflakeConnector.load("BLOCK_NAME") as conn:
conn.execute(
"CREATE TABLE IF NOT EXISTS customers (name varchar, address varchar);"
)
conn.execute_many(
"INSERT INTO customers (name, address) VALUES (%(name)s, %(address)s);",
seq_of_parameters=[
{"name": "Marvin", "address": "Highway 42"},
{"name": "Ford", "address": "Highway 42"},
{"name": "Unknown", "address": "Highway 42"},
{"name": "Me", "address": "Myway 88"},
],
)
result = conn.fetch_all(
"SELECT * FROM customers WHERE address = %(address)s",
parameters={"address": "Highway 42"},
)
print(result) # Marvin, Ford, Unknown
```
""" # noqa
inputs = dict(
command=operation,
params=parameters,
**execute_kwargs,
)
new, cursor = self._get_cursor(inputs, cursor_type)
if new:
await self._execute_async(cursor, inputs)
self.logger.debug("Preparing to fetch all rows.")
result = await run_sync_in_worker_thread(cursor.fetchall)
return result
@sync_compatible
async def execute(
self,
operation: str,
parameters: Optional[Dict[str, Any]] = None,
cursor_type: Type[SnowflakeCursor] = SnowflakeCursor,
**execute_kwargs: Any,
) -> None:
"""
Executes an operation on the database. This method is intended to be used
for operations that do not return data, such as INSERT, UPDATE, or DELETE.
Unlike the fetch methods, this method will always execute the operation
upon calling.
Args:
operation: The SQL query or other operation to be executed.
parameters: The parameters for the operation.
cursor_type: The class of the cursor to use when creating a Snowflake cursor.
**execute_kwargs: Additional options to pass to `cursor.execute_async`.
Examples:
Create table named customers with two columns, name and address.
```python
from prefect_snowflake.database import SnowflakeConnector
with SnowflakeConnector.load("BLOCK_NAME") as conn:
conn.execute(
"CREATE TABLE IF NOT EXISTS customers (name varchar, address varchar);"
)
```
""" # noqa
self._start_connection()
inputs = dict(
command=operation,
params=parameters,
**execute_kwargs,
)
with self._connection.cursor(cursor_type) as cursor:
await run_sync_in_worker_thread(cursor.execute, **inputs)
self.logger.info(f"Executed the operation, {operation!r}.")
@sync_compatible
async def execute_many(
self,
operation: str,
seq_of_parameters: List[Dict[str, Any]],
) -> None:
"""
Executes many operations on the database. This method is intended to be used
for operations that do not return data, such as INSERT, UPDATE, or DELETE.
Unlike the fetch methods, this method will always execute the operations
upon calling.
Args:
operation: The SQL query or other operation to be executed.
seq_of_parameters: The sequence of parameters for the operation.
Examples:
Create table and insert three rows into it.
```python
from prefect_snowflake.database import SnowflakeConnector
with SnowflakeConnector.load("BLOCK_NAME") as conn:
conn.execute(
"CREATE TABLE IF NOT EXISTS customers (name varchar, address varchar);"
)
conn.execute_many(
"INSERT INTO customers (name, address) VALUES (%(name)s, %(address)s);",
seq_of_parameters=[
{"name": "Marvin", "address": "Highway 42"},
{"name": "Ford", "address": "Highway 42"},
{"name": "Unknown", "address": "Space"},
],
)
```
""" # noqa
self._start_connection()
inputs = dict(
command=operation,
seqparams=seq_of_parameters,
)
with self._connection.cursor() as cursor:
await run_sync_in_worker_thread(cursor.executemany, **inputs)
self.logger.info(
f"Executed {len(seq_of_parameters)} operations off {operation!r}."
)
def close(self):
"""
Closes connection and its cursors.
"""
try:
self.reset_cursors()
finally:
if self._connection is None:
self.logger.info("There was no connection open to be closed.")
return
self._connection.close()
self._connection = None
self.logger.info("Successfully closed the Snowflake connection.")
def __enter__(self):
"""
Start a connection upon entry.
"""
return self
def __exit__(self, *args):
"""
Closes connection and its cursors upon exit.
"""
self.close()
def __getstate__(self):
"""Allows block to be pickled and dumped."""
data = self.__dict__.copy()
data.update({k: None for k in {"_connection", "_unique_cursors"}})
return data
def __setstate__(self, data: dict):
"""Reset connection and cursors upon loading."""
self.__dict__.update(data)
self._start_connection()
@task
async def snowflake_query(
query: str,
snowflake_connector: SnowflakeConnector,
params: Union[Tuple[Any], Dict[str, Any]] = None,
cursor_type: Type[SnowflakeCursor] = SnowflakeCursor,
poll_frequency_seconds: int = 1,
) -> List[Tuple[Any]]:
"""
Executes a query against a Snowflake database.
Args:
query: The query to execute against the database.
params: The params to replace the placeholders in the query.
snowflake_connector: The credentials to use to authenticate.
cursor_type: The type of database cursor to use for the query.
poll_frequency_seconds: Number of seconds to wait in between checks for
run completion.
Returns:
The output of `response.fetchall()`.
Examples:
Query Snowflake table with the ID value parameterized.
```python
from prefect import flow
from prefect_snowflake.credentials import SnowflakeCredentials
from prefect_snowflake.database import SnowflakeConnector, snowflake_query
@flow
def snowflake_query_flow():
snowflake_credentials = SnowflakeCredentials(
account="account",
user="user",
password="password",
)
snowflake_connector = SnowflakeConnector(
database="database",
warehouse="warehouse",
schema="schema",
credentials=snowflake_credentials
)
result = snowflake_query(
"SELECT * FROM table WHERE id=%{id_param}s LIMIT 8;",
snowflake_connector,
params={"id_param": 1}
)
return result
snowflake_query_flow()
```
"""
# context manager automatically rolls back failed transactions and closes
with snowflake_connector.get_connection() as connection:
with connection.cursor(cursor_type) as cursor:
response = cursor.execute_async(query, params=params)
query_id = response["queryId"]
while connection.is_still_running(
connection.get_query_status_throw_if_error(query_id)
):
await asyncio.sleep(poll_frequency_seconds)
cursor.get_results_from_sfqid(query_id)
result = cursor.fetchall()
return result
@task
async def snowflake_multiquery(
queries: List[str],
snowflake_connector: SnowflakeConnector,
params: Union[Tuple[Any], Dict[str, Any]] = None,
cursor_type: Type[SnowflakeCursor] = SnowflakeCursor,
as_transaction: bool = False,
return_transaction_control_results: bool = False,
poll_frequency_seconds: int = 1,
) -> List[List[Tuple[Any]]]:
"""
Executes multiple queries against a Snowflake database in a shared session.
Allows execution in a transaction.
Args:
queries: The list of queries to execute against the database.
params: The params to replace the placeholders in the query.
snowflake_connector: The credentials to use to authenticate.
cursor_type: The type of database cursor to use for the query.
as_transaction: If True, queries are executed in a transaction.
return_transaction_control_results: Determines if the results of queries
controlling the transaction (BEGIN/COMMIT) should be returned.
poll_frequency_seconds: Number of seconds to wait in between checks for
run completion.
Returns:
List of the outputs of `response.fetchall()` for each query.
Examples:
Query Snowflake table with the ID value parameterized.
```python
from prefect import flow
from prefect_snowflake.credentials import SnowflakeCredentials
from prefect_snowflake.database import SnowflakeConnector, snowflake_multiquery
@flow
def snowflake_multiquery_flow():
snowflake_credentials = SnowflakeCredentials(
account="account",
user="user",
password="password",
)
snowflake_connector = SnowflakeConnector(
database="database",
warehouse="warehouse",
schema="schema",
credentials=snowflake_credentials
)
result = snowflake_multiquery(
["SELECT * FROM table WHERE id=%{id_param}s LIMIT 8;", "SELECT 1,2"],
snowflake_connector,
params={"id_param": 1},
as_transaction=True
)
return result
snowflake_multiquery_flow()
```
"""
with snowflake_connector.get_connection() as connection:
if as_transaction:
queries.insert(0, BEGIN_TRANSACTION_STATEMENT)
queries.append(END_TRANSACTION_STATEMENT)
with connection.cursor(cursor_type) as cursor:
results = []
for query in queries:
response = cursor.execute_async(query, params=params)
query_id = response["queryId"]
while connection.is_still_running(
connection.get_query_status_throw_if_error(query_id)
):
await asyncio.sleep(poll_frequency_seconds)
cursor.get_results_from_sfqid(query_id)
result = cursor.fetchall()
results.append(result)
# cut off results from BEGIN/COMMIT queries
if as_transaction and not return_transaction_control_results:
return results[1:-1]
else:
return results
@task
async def snowflake_query_sync(
query: str,
snowflake_connector: SnowflakeConnector,
params: Union[Tuple[Any], Dict[str, Any]] = None,
cursor_type: Type[SnowflakeCursor] = SnowflakeCursor,
) -> List[Tuple[Any]]:
"""
Executes a query in sync mode against a Snowflake database.
Args:
query: The query to execute against the database.
params: The params to replace the placeholders in the query.
snowflake_connector: The credentials to use to authenticate.
cursor_type: The type of database cursor to use for the query.
Returns:
The output of `response.fetchall()`.
Examples:
Execute a put statement.
```python
from prefect import flow
from prefect_snowflake.credentials import SnowflakeCredentials
from prefect_snowflake.database import SnowflakeConnector, snowflake_query
@flow
def snowflake_query_sync_flow():
snowflake_credentials = SnowflakeCredentials(
account="account",
user="user",
password="password",
)
snowflake_connector = SnowflakeConnector(
database="database",
warehouse="warehouse",
schema="schema",
credentials=snowflake_credentials
)
result = snowflake_query_sync(
"put file://afile.csv @mystage;",
snowflake_connector,
)
return result
snowflake_query_sync_flow()
```
"""
# context manager automatically rolls back failed transactions and closes
with snowflake_connector.get_connection() as connection:
with connection.cursor(cursor_type) as cursor:
cursor.execute(query, params=params)
result = cursor.fetchall()
return result