-
Notifications
You must be signed in to change notification settings - Fork 71
/
connect.py
138 lines (103 loc) · 3.47 KB
/
connect.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
# Copyright (C) 2021 Derek Lane, Cancer Care Associates
# Copyright (C) 2018 Cancer Care Associates
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# http://www.apache.org/licenses/LICENSE-2.0
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""A toolbox for connecting to Mosaiq SQL.
"""
from typing import Dict, List, Tuple
from pymedphys._imports import pymssql
from . import credentials as _credentials
class Connection:
"""A Mosaiq DB Connection object.
A wrapper around the ``pymssql.Connection`` object.
"""
def __init__(
self,
username: str,
password: str,
hostname: str,
port: int = 1433,
database: str = "MOSAIQ",
):
try:
self._connection = pymssql.connect(
hostname, username, password, database=database, port=port
)
except pymssql.OperationalError as error:
error_message = error.args[0][1]
if error_message.startswith(b"Login failed for user"):
raise _credentials.WrongUsernameOrPassword(
"Wrong credentials"
) from error
raise ValueError(
f"When attempting to connect to {database}@{hostname}:{port} "
f"with the {username} user a pymssql.OperationalError was "
"raised"
) from error
def cursor(self) -> "Cursor":
return Cursor(self._connection)
def close(self):
self._connection.close()
def __enter__(self):
return self
def __exit__(self, *_):
self.close()
class Cursor:
"""A Mosaiq DB Cursor object.
A wrapper around the ``pymssql.Cursor`` object.
"""
def __init__(self, connection: "pymssql.Connection"):
self._cursor = connection.cursor()
def close(self):
self._cursor.close()
def execute(self, query: str, parameters: Dict = None):
self._cursor.execute(query, parameters)
def fetchall(self) -> List[Tuple[str, ...]]:
results: List[Tuple[str, ...]] = self._cursor.fetchall()
return results
def __enter__(self):
return self
def __exit__(self, *_):
self.close()
def connect_with_credentials(
username: str,
password: str,
hostname: str,
port: int = 1433,
database: str = "MOSAIQ",
) -> Connection:
"""Connects to a Mosaiq database.
Parameters
----------
username : str
password : str
hostname : str
The IP address or hostname of the SQL server.
port : int, optional
The port at which the SQL server is hosted, by default 1433
database : str, optional
The MSSQL database name, by default "MOSAIQ"
Returns
-------
connection : pymedphys.mosaiq.Connection
A connection object to the database for execution.
Raises
------
WrongUsernameOrPassword
If the wrong credentials are provided.
"""
connection = Connection(
username=username,
password=password,
hostname=hostname,
port=port,
database=database,
)
return connection