Mercurial > hg > orthanc-databases
annotate Framework/PostgreSQL/PostgreSQLResult.cpp @ 489:e8b4bb6a33e7
introduction of ORTHANC_SDK_COMPATIBLE_VERSIONS in CMake
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Fri, 22 Mar 2024 14:27:36 +0100 |
parents | f0976163dbe1 |
children | 54d518dcd74a |
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 | |
459
ecd0b719cff5
update year to 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
389
diff
changeset
|
5 * Copyright (C) 2017-2024 Osimis S.A., Belgium |
ecd0b719cff5
update year to 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
389
diff
changeset
|
6 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium |
0 | 7 * |
8 * This program is free software: you can redistribute it and/or | |
9 * modify it under the terms of the GNU Affero General Public License | |
10 * as published by the Free Software Foundation, either version 3 of | |
11 * the License, or (at your option) any later version. | |
12 * | |
13 * This program is distributed in the hope that it will be useful, but | |
14 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
16 * Affero General Public License for more details. | |
17 * | |
18 * You should have received a copy of the GNU Affero General Public License | |
19 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
20 **/ | |
21 | |
22 | |
107
5765cc5fd268
reverted fix for OS X that breaks other targets
Sebastien Jodogne <s.jodogne@orthanc-labs.com>
parents:
105
diff
changeset
|
23 #include "PostgreSQLIncludes.h" // Must be the first |
105 | 24 #include "PostgreSQLResult.h" |
0 | 25 |
26 #include "../Common/BinaryStringValue.h" | |
245
9d00e5e073e8
rename FileValue as ResultFileValue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
27 #include "../Common/ResultFileValue.h" |
0 | 28 #include "../Common/Integer64Value.h" |
29 #include "../Common/NullValue.h" | |
30 #include "../Common/Utf8StringValue.h" | |
31 | |
157
275e14f57f1e
replacing deprecated std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
152
diff
changeset
|
32 #include <Compatibility.h> // For std::unique_ptr<> |
152 | 33 #include <OrthancException.h> |
34 #include <Logging.h> | |
35 #include <Endianness.h> | |
0 | 36 |
37 #include <cassert> | |
38 #include <boost/lexical_cast.hpp> | |
39 | |
40 | |
41 namespace OrthancDatabases | |
42 { | |
43 void PostgreSQLResult::Clear() | |
44 { | |
45 if (result_ != NULL) | |
46 { | |
47 PQclear(reinterpret_cast<PGresult*>(result_)); | |
48 result_ = NULL; | |
49 } | |
50 } | |
51 | |
52 | |
53 void PostgreSQLResult::CheckDone() | |
54 { | |
55 if (position_ >= PQntuples(reinterpret_cast<PGresult*>(result_))) | |
56 { | |
57 // We are at the end of the result set | |
58 Clear(); | |
59 } | |
60 } | |
61 | |
62 | |
63 void PostgreSQLResult::CheckColumn(unsigned int column, unsigned int /*Oid*/ expectedType) const | |
64 { | |
65 if (IsDone()) | |
66 { | |
67 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadSequenceOfCalls); | |
68 } | |
69 | |
70 if (column >= static_cast<unsigned int>(PQnfields(reinterpret_cast<PGresult*>(result_)))) | |
71 { | |
72 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
73 } | |
74 | |
75 if (expectedType != 0 && | |
76 expectedType != PQftype(reinterpret_cast<PGresult*>(result_), column)) | |
77 { | |
78 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadParameterType); | |
79 } | |
80 } | |
81 | |
82 | |
83 PostgreSQLResult::PostgreSQLResult(PostgreSQLStatement& statement) : | |
84 position_(0), | |
85 database_(statement.GetDatabase()) | |
86 { | |
429
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
389
diff
changeset
|
87 if (database_.IsVerboseEnabled()) |
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
389
diff
changeset
|
88 { |
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
389
diff
changeset
|
89 LOG(INFO) << "PostgreSQL: " << statement.sql_; |
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
389
diff
changeset
|
90 } |
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
389
diff
changeset
|
91 |
0 | 92 result_ = statement.Execute(); |
93 assert(result_ != NULL); // An exception would have been thrown otherwise | |
94 | |
95 // This is the first call to "Next()" | |
96 if (PQresultStatus(reinterpret_cast<PGresult*>(result_)) == PGRES_TUPLES_OK) | |
97 { | |
98 CheckDone(); | |
99 columnsCount_ = static_cast<unsigned int>(PQnfields(reinterpret_cast<PGresult*>(result_))); | |
100 } | |
101 else | |
102 { | |
103 // This is not a SELECT request, we're done | |
104 Clear(); | |
105 columnsCount_ = 0; | |
106 } | |
107 } | |
108 | |
109 | |
46
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
14
diff
changeset
|
110 PostgreSQLResult::~PostgreSQLResult() |
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
14
diff
changeset
|
111 { |
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
14
diff
changeset
|
112 try |
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
14
diff
changeset
|
113 { |
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
14
diff
changeset
|
114 Clear(); |
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
14
diff
changeset
|
115 } |
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
14
diff
changeset
|
116 catch (Orthanc::OrthancException&) |
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
14
diff
changeset
|
117 { |
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
14
diff
changeset
|
118 // Ignore possible exceptions due to connection loss |
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
14
diff
changeset
|
119 } |
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 |
0 | 123 void PostgreSQLResult::Next() |
124 { | |
125 position_++; | |
126 CheckDone(); | |
127 } | |
128 | |
129 | |
130 bool PostgreSQLResult::IsNull(unsigned int column) const | |
131 { | |
132 CheckColumn(column, 0); | |
133 return PQgetisnull(reinterpret_cast<PGresult*>(result_), position_, column) != 0; | |
134 } | |
135 | |
136 | |
137 bool PostgreSQLResult::GetBoolean(unsigned int column) const | |
138 { | |
139 CheckColumn(column, BOOLOID); | |
140 assert(PQfsize(reinterpret_cast<PGresult*>(result_), column) == 1); | |
141 const uint8_t *v = reinterpret_cast<const uint8_t*> | |
142 (PQgetvalue(reinterpret_cast<PGresult*>(result_), position_, column)); | |
143 return (v[0] != 0); | |
144 } | |
145 | |
146 | |
147 int PostgreSQLResult::GetInteger(unsigned int column) const | |
148 { | |
149 CheckColumn(column, INT4OID); | |
150 assert(PQfsize(reinterpret_cast<PGresult*>(result_), column) == 4); | |
151 char *v = PQgetvalue(reinterpret_cast<PGresult*>(result_), position_, column); | |
152 return htobe32(*reinterpret_cast<int32_t*>(v)); | |
153 } | |
154 | |
155 | |
156 int64_t PostgreSQLResult::GetInteger64(unsigned int column) const | |
157 { | |
158 CheckColumn(column, INT8OID); | |
159 assert(PQfsize(reinterpret_cast<PGresult*>(result_), column) == 8); | |
160 char *v = PQgetvalue(reinterpret_cast<PGresult*>(result_), position_, column); | |
161 return htobe64(*reinterpret_cast<int64_t*>(v)); | |
162 } | |
163 | |
164 | |
165 std::string PostgreSQLResult::GetString(unsigned int column) const | |
166 { | |
167 CheckColumn(column, 0); | |
168 | |
169 Oid oid = PQftype(reinterpret_cast<PGresult*>(result_), column); | |
170 if (oid != TEXTOID && oid != VARCHAROID && oid != BYTEAOID) | |
171 { | |
172 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadParameterType); | |
173 } | |
174 | |
175 return std::string(PQgetvalue(reinterpret_cast<PGresult*>(result_), position_, column)); | |
176 } | |
177 | |
178 | |
246
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
179 std::string PostgreSQLResult::GetLargeObjectOid(unsigned int column) const |
0 | 180 { |
181 CheckColumn(column, OIDOID); | |
182 | |
242
b97a537f4613
MySQL: Support of range reads for the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
183 /** |
b97a537f4613
MySQL: Support of range reads for the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
184 * 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
|
185 * /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
|
186 **/ |
0 | 187 Oid oid; |
188 assert(PQfsize(reinterpret_cast<PGresult*>(result_), column) == sizeof(oid)); | |
189 | |
190 oid = *(const Oid*) PQgetvalue(reinterpret_cast<PGresult*>(result_), position_, column); | |
191 oid = ntohl(oid); | |
192 | |
246
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
193 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
|
194 } |
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 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
|
198 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
|
199 { |
248
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
246
diff
changeset
|
200 PostgreSQLLargeObject::ReadWhole(content, database_, GetLargeObjectOid(column)); |
0 | 201 } |
202 | |
203 | |
246
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
204 class PostgreSQLResult::LargeObjectResult : public ResultFileValue |
0 | 205 { |
246
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
206 private: |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
207 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
|
208 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
|
209 |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
210 public: |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
211 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
|
212 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
|
213 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
|
214 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
|
215 { |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
216 } |
0 | 217 |
246
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
218 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
|
219 { |
248
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
246
diff
changeset
|
220 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
|
221 } |
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 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
|
224 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
|
225 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
|
226 { |
248
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
246
diff
changeset
|
227 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
|
228 } |
483af3f35a4b
turning ResultFileValue into a base class, and implement its primitives for PostgreSQL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
245
diff
changeset
|
229 }; |
0 | 230 |
231 | |
232 IValue* PostgreSQLResult::GetValue(unsigned int column) const | |
233 { | |
234 if (IsNull(column)) | |
235 { | |
236 return new NullValue; | |
237 } | |
238 | |
239 Oid type = PQftype(reinterpret_cast<PGresult*>(result_), column); | |
240 | |
241 switch (type) | |
242 { | |
243 case BOOLOID: | |
244 // Convert Boolean values as integers | |
245 return new Integer64Value(GetBoolean(column) ? 1 : 0); | |
246 | |
247 case INT4OID: | |
248 return new Integer64Value(GetInteger(column)); | |
249 | |
250 case INT8OID: | |
251 return new Integer64Value(GetInteger64(column)); | |
252 | |
253 case TEXTOID: | |
254 case VARCHAROID: | |
255 return new Utf8StringValue(GetString(column)); | |
256 | |
257 case BYTEAOID: | |
258 return new BinaryStringValue(GetString(column)); | |
259 | |
260 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
|
261 return new LargeObjectResult(database_, GetLargeObjectOid(column)); |
0 | 262 |
435
326f8304daa1
new creating temporary tables inside functions
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
263 case VOIDOID: |
326f8304daa1
new creating temporary tables inside functions
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
264 return NULL; |
326f8304daa1
new creating temporary tables inside functions
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
265 |
0 | 266 default: |
267 throw Orthanc::OrthancException(Orthanc::ErrorCode_NotImplemented); | |
268 } | |
269 } | |
270 } |