/
sql_server.py
331 lines (288 loc) · 10.8 KB
/
sql_server.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
import pyodbc
from prefect import Task
from prefect.utilities.tasks import defaults_from_attrs
class SqlServerExecute(Task):
"""
Task for executing a query against a SQL Server database.
Args:
- db_name (str): name of SQL Server database
- user (str): user name used to authenticate
- host (str): database host address
- port (int, optional): port used to connect to SQL Server database, defaults to 1433 if
not provided
- driver (str, optional): driver used to communicate with SQL Server database
- query (str, optional): query to execute against database
- data (tuple, optional): values to use in query, must be specified using placeholder
in query string
- commit (bool, optional): set to True to commit transaction, defaults to false
- **kwargs (dict, optional): additional keyword arguments to pass to the
Task constructor
"""
def __init__(
self,
db_name: str,
user: str,
host: str,
port: int = 1433,
driver: str = "ODBC Driver 17 for SQL Server",
query: str = None,
data: tuple = None,
commit: bool = False,
**kwargs
):
self.db_name = db_name
self.user = user
self.host = host
self.port = port
self.driver = driver
self.query = query
self.data = data
self.commit = commit
super().__init__(**kwargs)
@defaults_from_attrs("query", "data", "commit")
def run(
self,
query: str = None,
data: tuple = None,
commit: bool = False,
password: str = None,
):
"""
Task run method. Executes a query against SQL Server database.
Args:
- query (str, optional): query to execute against database
- data (tuple, optional): values to use in query, must be specified using
placeholder in query string
- commit (bool, optional): set to True to commit transaction, defaults to false
- password (str): password used to authenticate; should be provided from a `Secret` task
Returns:
- None
Raises:
- ValueError: if query parameter is None or a blank string
- DatabaseError: if exception occurs when executing the query
"""
if not query:
raise ValueError("A query string must be provided")
# connect to database
cnxn = pyodbc.connect(
driver=self.driver,
host=self.host,
database=self.db_name,
port=self.port,
user=self.user,
password=password,
)
# try to execute query
# context manager automatically rolls back failed transactions
try:
with cnxn.cursor() as cursor:
executed = cursor.execute(query, data)
if commit:
cnxn.commit()
else:
cnxn.rollback()
return executed
# ensure connection is closed
finally:
cnxn.close()
class SqlServerExecuteMany(Task):
"""
Task for executing many queries against a SQL Server database.
Args:
- db_name (str): name of SQL Server database
- user (str): user name used to authenticate
- host (str): database host address
- port (int, optional): port used to connect to SQL Server database, defaults to 1433 if
not provided
- driver (str, optional): driver used to communicate with SQL Server database
- query (str, optional): query to execute against database
- data (tuple, optional): values to use in query, must be specified using placeholder
in query string
- commit (bool, optional): set to True to commit transaction, defaults to false
- **kwargs (dict, optional): additional keyword arguments to pass to the
Task constructor
"""
def __init__(
self,
db_name: str,
user: str,
host: str,
port: int = 1433,
driver: str = "ODBC Driver 17 for SQL Server",
query: str = None,
data: tuple = None,
commit: bool = False,
**kwargs
):
self.db_name = db_name
self.user = user
self.host = host
self.port = port
self.driver = driver
self.query = query
self.data = data
self.commit = commit
super().__init__(**kwargs)
@defaults_from_attrs("query", "data", "commit")
def run(
self,
query: str = None,
data: list = None,
commit: bool = False,
password: str = None,
fast_executemany=False,
):
"""
Task run method. Executes many queries against SQL Server database.
Args:
- query (str, optional): query to execute against database
- data (List[tuple], optional): list of values to use in query, must be specified using
placeholder
- commit (bool, optional): set to True to commit transaction, defaults to false
- password (str): password used to authenticate; should be provided from a `Secret` task
- fast_executemany (bool, optional): sends all params to the DB server in one bundle with
the SQL statement. DB executes the SQL against all the params as one DB transaction
Returns:
- None
Raises:
- ValueError: if query parameter is None or a blank string
- DatabaseError: if exception occurs when executing the query
"""
if not query:
raise ValueError("A query string must be provided")
if not data:
raise ValueError("A data list must be provided")
# connect to database
cnxn = pyodbc.connect(
driver=self.driver,
host=self.host,
database=self.db_name,
port=self.port,
user=self.user,
password=password,
)
# try to execute query
# context manager automatically rolls back failed transactions
try:
with cnxn.cursor() as cursor:
if fast_executemany:
cursor.fast_executemany = True
executed = cursor.executemany(query, data)
if commit:
cnxn.commit()
else:
cnxn.rollback()
return executed
# ensure connection is closed
finally:
cnxn.close()
class SqlServerFetch(Task):
"""
Task for fetching results of query from SQL Server database.
Args:
- db_name (str): name of SQL Server database
- user (str): user name used to authenticate
- host (str): database host address
- port (int, optional): port used to connect to SQL Server database, defaults to 5432 if
not provided
- driver (str, optional): driver used to communicate with SQL Server database
- fetch (str, optional): one of "one" "many" or "all", used to determine how many
results to fetch from executed query
- fetch_count (int, optional): if fetch = 'many', determines the number of results
to fetch, defaults to 10
- query (str, optional): query to execute against database
- data (tuple, optional): values to use in query, must be specified using placeholder
in query string
- commit (bool, optional): set to True to commit transaction, defaults to false
- **kwargs (dict, optional): additional keyword arguments to pass to the
Task constructor
"""
def __init__(
self,
db_name: str,
user: str,
host: str,
port: int = 1433,
driver: str = "ODBC Driver 17 for SQL Server",
fetch: str = "one",
fetch_count: int = 10,
query: str = None,
data: tuple = None,
commit: bool = False,
**kwargs
):
self.db_name = db_name
self.user = user
self.host = host
self.port = port
self.fetch = fetch
self.fetch_count = fetch_count
self.driver = driver
self.query = query
self.data = data
self.commit = commit
super().__init__(**kwargs)
@defaults_from_attrs("fetch", "fetch_count", "query", "data", "commit")
def run(
self,
fetch: str = "one",
fetch_count: int = 10,
query: str = None,
data: tuple = None,
commit: bool = False,
password: str = None,
):
"""
Task run method. Executes a query against SQL Server database and fetches results.
Args:
- fetch (str, optional): one of "one" "many" or "all", used to determine how many
results to fetch from executed query
- fetch_count (int, optional): if fetch = 'many', determines the number of results
to fetch, defaults to 10
- query (str, optional): query to execute against database
- data (tuple, optional): values to use in query, must be specified using
placeholder in query string
- commit (bool, optional): set to True to commit transaction, defaults to false
- password (str): password used to authenticate; should be provided from a `Secret` task
Returns:
- records (tuple or list of tuples): records from provided query
Raises:
- ValueError: if query parameter is None or a blank string
- DatabaseError: if exception occurs when executing the query
"""
if not query:
raise ValueError("A query string must be provided")
if fetch not in {"one", "many", "all"}:
raise ValueError(
"The 'fetch' parameter must be one of the following - ('one', 'many', 'all')"
)
# connect to database
cnxn = pyodbc.connect(
driver=self.driver,
host=self.host,
database=self.db_name,
port=self.port,
user=self.user,
password=password,
)
# try to execute query
# context manager automatically rolls back failed transactions
try:
with cnxn.cursor() as crsr:
if data:
crsr.execute(query, data)
else:
crsr.execute(query)
# fetch results
if fetch == "all":
records = crsr.fetchall()
elif fetch == "many":
records = crsr.fetchmany(fetch_count)
else:
records = crsr.fetchone()
if commit:
cnxn.commit()
return records
# ensure connection is closed
finally:
cnxn.close()