Mercurial > hg > orthanc-databases
annotate Framework/PostgreSQL/PostgreSQLResult.cpp @ 580:35d2df9572b1 find-refactoring tip
count-resources
author | Alain Mazy <am@orthanc.team> |
---|---|
date | Tue, 15 Oct 2024 15:52:39 +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:
460
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:
460
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 | |
107
5765cc5fd268
reverted fix for OS X that breaks other targets
Sebastien Jodogne <s.jodogne@orthanc-labs.com>
parents:
105
diff
changeset
|
24 #include "PostgreSQLIncludes.h" // Must be the first |
105 | 25 #include "PostgreSQLResult.h" |
0 | 26 |
27 #include "../Common/BinaryStringValue.h" | |
245
9d00e5e073e8
rename FileValue as ResultFileValue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
28 #include "../Common/ResultFileValue.h" |
0 | 29 #include "../Common/Integer64Value.h" |
30 #include "../Common/NullValue.h" | |
31 #include "../Common/Utf8StringValue.h" | |
32 | |
157
275e14f57f1e
replacing deprecated std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
152
diff
changeset
|
33 #include <Compatibility.h> // For std::unique_ptr<> |
152 | 34 #include <OrthancException.h> |
35 #include <Logging.h> | |
36 #include <Endianness.h> | |
0 | 37 |
38 #include <cassert> | |
39 #include <boost/lexical_cast.hpp> | |
40 | |
41 | |
42 namespace OrthancDatabases | |
43 { | |
44 void PostgreSQLResult::Clear() | |
45 { | |
46 if (result_ != NULL) | |
47 { | |
48 PQclear(reinterpret_cast<PGresult*>(result_)); | |
49 result_ = NULL; | |
50 } | |
51 } | |
52 | |
53 | |
54 void PostgreSQLResult::CheckDone() | |
55 { | |
56 if (position_ >= PQntuples(reinterpret_cast<PGresult*>(result_))) | |
57 { | |
58 // We are at the end of the result set | |
59 Clear(); | |
60 } | |
61 } | |
62 | |
63 | |
64 void PostgreSQLResult::CheckColumn(unsigned int column, unsigned int /*Oid*/ expectedType) const | |
65 { | |
66 if (IsDone()) | |
67 { | |
68 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadSequenceOfCalls); | |
69 } | |
70 | |
71 if (column >= static_cast<unsigned int>(PQnfields(reinterpret_cast<PGresult*>(result_)))) | |
72 { | |
73 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
74 } | |
75 | |
76 if (expectedType != 0 && | |
77 expectedType != PQftype(reinterpret_cast<PGresult*>(result_), column)) | |
78 { | |
79 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadParameterType); | |
80 } | |
81 } | |
82 | |
83 | |
84 PostgreSQLResult::PostgreSQLResult(PostgreSQLStatement& statement) : | |
85 position_(0), | |
86 database_(statement.GetDatabase()) | |
87 { | |
429
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
389
diff
changeset
|
88 if (database_.IsVerboseEnabled()) |
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
389
diff
changeset
|
89 { |
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
389
diff
changeset
|
90 LOG(INFO) << "PostgreSQL: " << statement.sql_; |
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
389
diff
changeset
|
91 } |
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
389
diff
changeset
|
92 |
0 | 93 result_ = statement.Execute(); |
94 assert(result_ != NULL); // An exception would have been thrown otherwise | |
95 | |
96 // This is the first call to "Next()" | |
97 if (PQresultStatus(reinterpret_cast<PGresult*>(result_)) == PGRES_TUPLES_OK) | |
98 { | |
99 CheckDone(); | |
100 columnsCount_ = static_cast<unsigned int>(PQnfields(reinterpret_cast<PGresult*>(result_))); | |
101 } | |
102 else | |
103 { | |
104 // This is not a SELECT request, we're done | |
105 Clear(); | |
106 columnsCount_ = 0; | |
107 } | |
108 } | |
109 | |
110 | |
46
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
14
diff
changeset
|
111 PostgreSQLResult::~PostgreSQLResult() |
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
14
diff
changeset
|
112 { |
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
14
diff
changeset
|
113 try |
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
14
diff
changeset
|
114 { |
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
14
diff
changeset
|
115 Clear(); |
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
14
diff
changeset
|
116 } |
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
14
diff
changeset
|
117 catch (Orthanc::OrthancException&) |
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
14
diff
changeset
|
118 { |
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
14
diff
changeset
|
119 // Ignore possible exceptions due to connection loss |
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
14
diff
changeset
|
120 } |
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
14
diff
changeset
|
121 } |
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
14
diff
changeset
|
122 |
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
14
diff
changeset
|
123 |
0 | 124 void PostgreSQLResult::Next() |
125 { | |
126 position_++; | |
127 CheckDone(); | |
128 } | |
129 | |
130 | |
131 bool PostgreSQLResult::IsNull(unsigned int column) const | |
132 { | |
133 CheckColumn(column, 0); | |
134 return PQgetisnull(reinterpret_cast<PGresult*>(result_), position_, column) != 0; | |
135 } | |
136 | |
137 | |
138 bool PostgreSQLResult::GetBoolean(unsigned int column) const | |
139 { | |
140 CheckColumn(column, BOOLOID); | |
141 assert(PQfsize(reinterpret_cast<PGresult*>(result_), column) == 1); | |
142 const uint8_t *v = reinterpret_cast<const uint8_t*> | |
143 (PQgetvalue(reinterpret_cast<PGresult*>(result_), position_, column)); | |
144 return (v[0] != 0); | |
145 } | |
146 | |
147 | |
148 int PostgreSQLResult::GetInteger(unsigned int column) const | |
149 { | |
150 CheckColumn(column, INT4OID); | |
151 assert(PQfsize(reinterpret_cast<PGresult*>(result_), column) == 4); | |
152 char *v = PQgetvalue(reinterpret_cast<PGresult*>(result_), position_, column); | |
153 return htobe32(*reinterpret_cast<int32_t*>(v)); | |
154 } | |
155 | |
156 | |
157 int64_t PostgreSQLResult::GetInteger64(unsigned int column) const | |
158 { | |
159 CheckColumn(column, INT8OID); | |
160 assert(PQfsize(reinterpret_cast<PGresult*>(result_), column) == 8); | |
161 char *v = PQgetvalue(reinterpret_cast<PGresult*>(result_), position_, column); | |
162 return htobe64(*reinterpret_cast<int64_t*>(v)); | |
163 } | |
164 | |
165 | |
166 std::string PostgreSQLResult::GetString(unsigned int column) const | |
167 { | |
168 CheckColumn(column, 0); | |
169 | |
170 Oid oid = PQftype(reinterpret_cast<PGresult*>(result_), column); | |
171 if (oid != TEXTOID && oid != VARCHAROID && oid != BYTEAOID) | |
172 { | |
173 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadParameterType); | |
174 } | |
175 | |
176 return std::string(PQgetvalue(reinterpret_cast<PGresult*>(result_), position_, column)); | |
177 } | |
178 | |
179 | |
246
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
180 std::string PostgreSQLResult::GetLargeObjectOid(unsigned int column) const |
0 | 181 { |
182 CheckColumn(column, OIDOID); | |
183 | |
242
b97a537f4613
MySQL: Support of range reads for the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
184 /** |
b97a537f4613
MySQL: Support of range reads for the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
185 * In PostgreSQL, the type "Oid" corresponds to "unsigned int", cf. |
b97a537f4613
MySQL: Support of range reads for the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
186 * /usr/include/postgresql/10/server/postgres_ext.h |
b97a537f4613
MySQL: Support of range reads for the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
187 **/ |
0 | 188 Oid oid; |
189 assert(PQfsize(reinterpret_cast<PGresult*>(result_), column) == sizeof(oid)); | |
190 | |
191 oid = *(const Oid*) PQgetvalue(reinterpret_cast<PGresult*>(result_), position_, column); | |
192 oid = ntohl(oid); | |
193 | |
246
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
194 return boost::lexical_cast<std::string>(oid); |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
195 } |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
196 |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
197 |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
198 void PostgreSQLResult::GetLargeObjectContent(std::string& content, |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
199 unsigned int column) const |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
200 { |
248
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
246
diff
changeset
|
201 PostgreSQLLargeObject::ReadWhole(content, database_, GetLargeObjectOid(column)); |
0 | 202 } |
203 | |
204 | |
246
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
205 class PostgreSQLResult::LargeObjectResult : public ResultFileValue |
0 | 206 { |
246
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
207 private: |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
208 PostgreSQLDatabase& database_; |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
209 std::string oid_; |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
210 |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
211 public: |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
212 LargeObjectResult(PostgreSQLDatabase& database, |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
213 const std::string& oid) : |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
214 database_(database), |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
215 oid_(oid) |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
216 { |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
217 } |
0 | 218 |
246
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
219 virtual void ReadWhole(std::string& target) const ORTHANC_OVERRIDE |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
220 { |
248
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
246
diff
changeset
|
221 PostgreSQLLargeObject::ReadWhole(target, database_, oid_); |
246
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
222 } |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
223 |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
224 virtual void ReadRange(std::string& target, |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
225 uint64_t start, |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
226 size_t length) const ORTHANC_OVERRIDE |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
227 { |
248
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
246
diff
changeset
|
228 PostgreSQLLargeObject::ReadRange(target, database_, oid_, start, length); |
246
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
229 } |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
230 }; |
0 | 231 |
232 | |
233 IValue* PostgreSQLResult::GetValue(unsigned int column) const | |
234 { | |
235 if (IsNull(column)) | |
236 { | |
237 return new NullValue; | |
238 } | |
239 | |
240 Oid type = PQftype(reinterpret_cast<PGresult*>(result_), column); | |
241 | |
242 switch (type) | |
243 { | |
244 case BOOLOID: | |
245 // Convert Boolean values as integers | |
246 return new Integer64Value(GetBoolean(column) ? 1 : 0); | |
247 | |
248 case INT4OID: | |
249 return new Integer64Value(GetInteger(column)); | |
250 | |
251 case INT8OID: | |
252 return new Integer64Value(GetInteger64(column)); | |
253 | |
254 case TEXTOID: | |
255 case VARCHAROID: | |
256 return new Utf8StringValue(GetString(column)); | |
257 | |
258 case BYTEAOID: | |
259 return new BinaryStringValue(GetString(column)); | |
260 | |
261 case OIDOID: | |
246
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
262 return new LargeObjectResult(database_, GetLargeObjectOid(column)); |
0 | 263 |
435
326f8304daa1
new creating temporary tables inside functions
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
264 case VOIDOID: |
326f8304daa1
new creating temporary tables inside functions
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
265 return NULL; |
326f8304daa1
new creating temporary tables inside functions
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
266 |
0 | 267 default: |
268 throw Orthanc::OrthancException(Orthanc::ErrorCode_NotImplemented); | |
269 } | |
270 } | |
271 } |