Mercurial > hg > orthanc-databases
annotate Framework/PostgreSQL/PostgreSQLParameters.cpp @ 534:f3738a6351c2 large-queries
clsing large-queries branch
author | Alain Mazy <am@orthanc.team> |
---|---|
date | Fri, 06 Sep 2024 15:32:26 +0200 |
parents | 54d518dcd74a |
children |
rev | line source |
---|---|
0 | 1 /** |
2 * Orthanc - A Lightweight, RESTful DICOM Store | |
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
4 * Department, University Hospital of Liege, Belgium | |
507
54d518dcd74a
updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
497
diff
changeset
|
5 * Copyright (C) 2017-2023 Osimis S.A., Belgium |
54d518dcd74a
updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
497
diff
changeset
|
6 * Copyright (C) 2024-2024 Orthanc Team SRL, Belgium |
459
ecd0b719cff5
update year to 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
389
diff
changeset
|
7 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium |
0 | 8 * |
9 * This program is free software: you can redistribute it and/or | |
10 * modify it under the terms of the GNU Affero General Public License | |
11 * as published by the Free Software Foundation, either version 3 of | |
12 * the License, or (at your option) any later version. | |
13 * | |
14 * This program is distributed in the hope that it will be useful, but | |
15 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
17 * Affero General Public License for more details. | |
18 * | |
19 * You should have received a copy of the GNU Affero General Public License | |
20 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
21 **/ | |
22 | |
23 | |
24 #include "PostgreSQLParameters.h" | |
25 | |
152 | 26 #include <Logging.h> |
27 #include <OrthancException.h> | |
0 | 28 |
29 #include <boost/lexical_cast.hpp> | |
30 | |
31 | |
32 namespace OrthancDatabases | |
33 { | |
34 void PostgreSQLParameters::Reset() | |
35 { | |
36 host_ = "localhost"; | |
37 port_ = 5432; | |
38 username_ = ""; | |
39 password_ = ""; | |
40 database_.clear(); | |
41 uri_.clear(); | |
80
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
42 ssl_ = false; |
0 | 43 lock_ = true; |
141
0b3e9ee53c46
Added 'MaximumConnectionRetries' & 'ConnectionRetryInterval' to configure the retries when connecting to the DB at startup
Alain Mazy <alain@mazy.be>
parents:
140
diff
changeset
|
44 maxConnectionRetries_ = 10; |
0b3e9ee53c46
Added 'MaximumConnectionRetries' & 'ConnectionRetryInterval' to configure the retries when connecting to the DB at startup
Alain Mazy <alain@mazy.be>
parents:
140
diff
changeset
|
45 connectionRetryInterval_ = 5; |
429
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
417
diff
changeset
|
46 isVerboseEnabled_ = false; |
496
4a76aca03774
fixed uninitialized variable PostgreSQL::isolationMode_
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
467
diff
changeset
|
47 isolationMode_ = IsolationMode_Serializable; |
0 | 48 } |
49 | |
50 | |
51 PostgreSQLParameters::PostgreSQLParameters() | |
52 { | |
53 Reset(); | |
54 } | |
55 | |
56 | |
57 PostgreSQLParameters::PostgreSQLParameters(const OrthancPlugins::OrthancConfiguration& configuration) | |
58 { | |
59 Reset(); | |
60 | |
61 std::string s; | |
62 | |
63 if (configuration.LookupStringValue(s, "ConnectionUri")) | |
64 { | |
65 SetConnectionUri(s); | |
66 } | |
67 else | |
68 { | |
69 if (configuration.LookupStringValue(s, "Host")) | |
70 { | |
71 SetHost(s); | |
72 } | |
73 | |
74 unsigned int port; | |
75 if (configuration.LookupUnsignedIntegerValue(port, "Port")) | |
76 { | |
77 SetPortNumber(port); | |
78 } | |
79 | |
80 if (configuration.LookupStringValue(s, "Database")) | |
81 { | |
82 SetDatabase(s); | |
83 } | |
84 | |
85 if (configuration.LookupStringValue(s, "Username")) | |
86 { | |
87 SetUsername(s); | |
88 } | |
89 | |
90 if (configuration.LookupStringValue(s, "Password")) | |
91 { | |
92 SetPassword(s); | |
93 } | |
80
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
94 |
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
95 ssl_ = configuration.GetBooleanValue("EnableSsl", false); |
0 | 96 } |
97 | |
98 lock_ = configuration.GetBooleanValue("Lock", true); // Use locking by default | |
141
0b3e9ee53c46
Added 'MaximumConnectionRetries' & 'ConnectionRetryInterval' to configure the retries when connecting to the DB at startup
Alain Mazy <alain@mazy.be>
parents:
140
diff
changeset
|
99 |
429
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
417
diff
changeset
|
100 isVerboseEnabled_ = configuration.GetBooleanValue("EnableVerboseLogs", false); |
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
417
diff
changeset
|
101 |
141
0b3e9ee53c46
Added 'MaximumConnectionRetries' & 'ConnectionRetryInterval' to configure the retries when connecting to the DB at startup
Alain Mazy <alain@mazy.be>
parents:
140
diff
changeset
|
102 maxConnectionRetries_ = configuration.GetUnsignedIntegerValue("MaximumConnectionRetries", 10); |
0b3e9ee53c46
Added 'MaximumConnectionRetries' & 'ConnectionRetryInterval' to configure the retries when connecting to the DB at startup
Alain Mazy <alain@mazy.be>
parents:
140
diff
changeset
|
103 connectionRetryInterval_ = configuration.GetUnsignedIntegerValue("ConnectionRetryInterval", 5); |
370
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
104 |
467
ff84104f7842
renamed v6.2 to REV2 + removed 'default' TransactionMode + renamed 'READ COMMITTED' into 'ReadCommitted'
Alain Mazy <am@osimis.io>
parents:
460
diff
changeset
|
105 std::string transactionMode = configuration.GetStringValue("TransactionMode", "Serializable"); |
ff84104f7842
renamed v6.2 to REV2 + removed 'default' TransactionMode + renamed 'READ COMMITTED' into 'ReadCommitted'
Alain Mazy <am@osimis.io>
parents:
460
diff
changeset
|
106 if (transactionMode == "ReadCommitted") |
432
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
107 { |
457 | 108 LOG(WARNING) << "PostgreSQL: using READ COMMITTED transaction mode"; |
432
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
109 SetIsolationMode(IsolationMode_ReadCommited); |
370
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
110 } |
467
ff84104f7842
renamed v6.2 to REV2 + removed 'default' TransactionMode + renamed 'READ COMMITTED' into 'ReadCommitted'
Alain Mazy <am@osimis.io>
parents:
460
diff
changeset
|
111 else if (transactionMode == "Serializable") |
370
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
112 { |
457 | 113 LOG(WARNING) << "PostgreSQL: using SERIALIZABLE transaction mode"; |
432
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
114 SetIsolationMode(IsolationMode_Serializable); |
370
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
115 } |
432
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
116 else |
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
117 { |
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
118 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadParameterType, std::string("Invalid value for 'TransactionMode': ") + transactionMode); |
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
119 } |
0 | 120 } |
121 | |
122 | |
123 void PostgreSQLParameters::SetConnectionUri(const std::string& uri) | |
124 { | |
125 uri_ = uri; | |
126 } | |
127 | |
128 | |
129 std::string PostgreSQLParameters::GetConnectionUri() const | |
130 { | |
131 if (uri_.empty()) | |
132 { | |
133 std::string actualUri = "postgresql://"; | |
134 | |
135 if (!username_.empty()) | |
136 { | |
137 actualUri += username_; | |
138 | |
139 if (!password_.empty()) | |
140 { | |
141 actualUri += ":" + password_; | |
142 } | |
143 | |
144 actualUri += "@" + host_; | |
145 } | |
146 else | |
147 { | |
148 actualUri += host_; | |
149 } | |
150 | |
151 if (port_ > 0) | |
152 { | |
153 actualUri += ":" + boost::lexical_cast<std::string>(port_); | |
154 } | |
155 | |
156 actualUri += "/" + database_; | |
157 | |
158 return actualUri; | |
159 } | |
160 else | |
161 { | |
162 return uri_; | |
163 } | |
164 } | |
165 | |
166 | |
167 void PostgreSQLParameters::SetHost(const std::string& host) | |
168 { | |
169 uri_.clear(); | |
170 host_ = host; | |
171 } | |
172 | |
173 void PostgreSQLParameters::SetPortNumber(unsigned int port) | |
174 { | |
252 | 175 if (port == 0 || |
0 | 176 port >= 65535) |
177 { | |
178 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
179 } | |
180 | |
181 uri_.clear(); | |
182 port_ = port; | |
183 } | |
184 | |
185 void PostgreSQLParameters::SetUsername(const std::string& username) | |
186 { | |
187 uri_.clear(); | |
188 username_ = username; | |
189 } | |
190 | |
191 void PostgreSQLParameters::SetPassword(const std::string& password) | |
192 { | |
193 uri_.clear(); | |
194 password_ = password; | |
195 } | |
196 | |
197 void PostgreSQLParameters::SetDatabase(const std::string& database) | |
198 { | |
199 uri_.clear(); | |
200 database_ = database; | |
201 } | |
202 | |
497 | 203 const std::string PostgreSQLParameters::GetReadWriteTransactionStatement() const |
204 { | |
205 switch (isolationMode_) | |
206 { | |
207 case IsolationMode_ReadCommited: | |
208 return "SET TRANSACTION ISOLATION LEVEL READ COMMITTED READ WRITE"; | |
209 | |
210 case IsolationMode_Serializable: | |
211 return "SET TRANSACTION ISOLATION LEVEL SERIALIZABLE READ WRITE"; | |
212 | |
213 default: | |
214 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
215 } | |
216 } | |
217 | |
218 const std::string PostgreSQLParameters::GetReadOnlyTransactionStatement() const | |
219 { | |
220 switch (isolationMode_) | |
221 { | |
222 case IsolationMode_ReadCommited: | |
223 return "SET TRANSACTION ISOLATION LEVEL READ COMMITTED READ ONLY"; | |
224 | |
225 case IsolationMode_Serializable: | |
226 return "SET TRANSACTION ISOLATION LEVEL SERIALIZABLE READ ONLY"; | |
227 | |
228 default: | |
229 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
230 } | |
231 } | |
232 | |
0 | 233 void PostgreSQLParameters::Format(std::string& target) const |
234 { | |
235 if (uri_.empty()) | |
236 { | |
80
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
237 // Note about SSL: "require" means that "I want my data to be |
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
238 // encrypted, and I accept the overhead. I trust that the |
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
239 // network will make sure I always connect to the server I want." |
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
240 // https://www.postgresql.org/docs/current/libpq-ssl.html |
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
241 target = std::string(ssl_ ? "sslmode=require" : "sslmode=disable") + |
0 | 242 " user=" + username_ + |
243 " host=" + host_ + | |
244 " port=" + boost::lexical_cast<std::string>(port_); | |
245 | |
10
3686ba3f9cdb
don't include password in connection string if it is empty; it's seems its not supported by some pg drivers
am@osimis.io
parents:
0
diff
changeset
|
246 if (!password_.empty()) |
3686ba3f9cdb
don't include password in connection string if it is empty; it's seems its not supported by some pg drivers
am@osimis.io
parents:
0
diff
changeset
|
247 { |
3686ba3f9cdb
don't include password in connection string if it is empty; it's seems its not supported by some pg drivers
am@osimis.io
parents:
0
diff
changeset
|
248 target += " password=" + password_; |
3686ba3f9cdb
don't include password in connection string if it is empty; it's seems its not supported by some pg drivers
am@osimis.io
parents:
0
diff
changeset
|
249 } |
3686ba3f9cdb
don't include password in connection string if it is empty; it's seems its not supported by some pg drivers
am@osimis.io
parents:
0
diff
changeset
|
250 |
0 | 251 if (database_.size() > 0) |
252 { | |
253 target += " dbname=" + database_; | |
254 } | |
255 } | |
256 else | |
257 { | |
258 target = uri_; | |
259 } | |
260 } | |
261 } |