Mercurial > hg > orthanc-databases
annotate Framework/PostgreSQL/PostgreSQLLargeObject.cpp @ 522:c49136b34891 large-queries tip
use a prepared statement for InsertOrUpdateMetadata
| author | Alain Mazy <am@orthanc.team> |
|---|---|
| date | Fri, 05 Jul 2024 09:15:54 +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:
459
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:
459
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 // http://www.postgresql.org/docs/9.1/static/lo-interfaces.html#AEN33102 | |
| 25 | |
|
107
5765cc5fd268
reverted fix for OS X that breaks other targets
Sebastien Jodogne <s.jodogne@orthanc-labs.com>
parents:
105
diff
changeset
|
26 #include "PostgreSQLIncludes.h" // Must be the first |
| 105 | 27 #include "PostgreSQLLargeObject.h" |
| 0 | 28 |
| 152 | 29 #include <Logging.h> |
| 30 #include <OrthancException.h> | |
| 0 | 31 |
| 32 #include <boost/lexical_cast.hpp> | |
| 33 #include <libpq/libpq-fs.h> | |
| 34 | |
| 35 | |
| 36 namespace OrthancDatabases | |
| 37 { | |
| 38 void PostgreSQLLargeObject::Create() | |
| 39 { | |
| 40 PGconn* pg = reinterpret_cast<PGconn*>(database_.pg_); | |
| 41 | |
| 42 oid_ = lo_creat(pg, INV_WRITE); | |
| 43 if (oid_ == 0) | |
| 44 { | |
| 45 LOG(ERROR) << "PostgreSQL: Cannot create a large object"; | |
| 46 database_.ThrowException(false); | |
| 47 } | |
| 48 } | |
| 49 | |
| 50 | |
| 51 void PostgreSQLLargeObject::Write(const void* data, | |
| 52 size_t size) | |
| 53 { | |
| 54 static int MAX_CHUNK_SIZE = 16 * 1024 * 1024; | |
| 55 | |
| 56 PGconn* pg = reinterpret_cast<PGconn*>(database_.pg_); | |
| 57 | |
| 58 int fd = lo_open(pg, oid_, INV_WRITE); | |
| 59 if (fd < 0) | |
| 60 { | |
| 61 database_.ThrowException(true); | |
| 62 } | |
| 63 | |
| 64 const char* position = reinterpret_cast<const char*>(data); | |
| 65 while (size > 0) | |
| 66 { | |
| 67 int chunk = (size > static_cast<size_t>(MAX_CHUNK_SIZE) ? | |
| 68 MAX_CHUNK_SIZE : static_cast<int>(size)); | |
| 69 int nbytes = lo_write(pg, fd, position, chunk); | |
| 70 if (nbytes <= 0) | |
| 71 { | |
| 72 lo_close(pg, fd); | |
| 73 database_.ThrowException(true); | |
| 74 } | |
| 75 | |
| 76 size -= nbytes; | |
| 77 position += nbytes; | |
| 78 } | |
| 79 | |
| 80 lo_close(pg, fd); | |
| 81 } | |
| 82 | |
| 83 | |
| 84 PostgreSQLLargeObject::PostgreSQLLargeObject(PostgreSQLDatabase& database, | |
| 85 const std::string& s) : | |
| 86 database_(database) | |
| 87 { | |
| 88 Create(); | |
| 89 | |
| 90 if (s.size() != 0) | |
| 91 { | |
| 92 Write(s.c_str(), s.size()); | |
| 93 } | |
| 94 else | |
| 95 { | |
| 96 Write(NULL, 0); | |
| 97 } | |
| 98 } | |
| 99 | |
| 100 | |
| 101 class PostgreSQLLargeObject::Reader | |
| 102 { | |
| 103 private: | |
| 104 PostgreSQLDatabase& database_; | |
| 105 int fd_; | |
| 106 size_t size_; | |
| 107 | |
|
248
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
108 void ReadInternal(PGconn* pg, |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
109 std::string& target) |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
110 { |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
111 for (size_t position = 0; position < target.size(); ) |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
112 { |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
113 size_t remaining = target.size() - position; |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
114 |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
115 int nbytes = lo_read(pg, fd_, &target[position], remaining); |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
116 if (nbytes < 0) |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
117 { |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
118 LOG(ERROR) << "PostgreSQL: Unable to read the large object in the database"; |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
119 database_.ThrowException(false); |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
120 } |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
121 |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
122 position += static_cast<size_t>(nbytes); |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
123 } |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
124 } |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
125 |
| 0 | 126 public: |
| 127 Reader(PostgreSQLDatabase& database, | |
| 128 const std::string& oid) : | |
| 129 database_(database) | |
| 130 { | |
| 131 PGconn* pg = reinterpret_cast<PGconn*>(database.pg_); | |
| 132 Oid id = boost::lexical_cast<Oid>(oid); | |
| 133 | |
| 134 fd_ = lo_open(pg, id, INV_READ); | |
| 135 | |
| 136 if (fd_ < 0 || | |
| 137 lo_lseek(pg, fd_, 0, SEEK_END) < 0) | |
| 138 { | |
| 139 LOG(ERROR) << "PostgreSQL: No such large object in the database; " | |
| 140 << "Make sure you use a transaction"; | |
| 141 database.ThrowException(false); | |
| 142 } | |
| 143 | |
| 144 // Get the size of the large object | |
| 145 int size = lo_tell(pg, fd_); | |
| 146 if (size < 0) | |
| 147 { | |
| 148 database.ThrowException(true); | |
| 149 } | |
| 150 size_ = static_cast<size_t>(size); | |
| 151 } | |
| 152 | |
| 153 ~Reader() | |
| 154 { | |
| 155 lo_close(reinterpret_cast<PGconn*>(database_.pg_), fd_); | |
| 156 } | |
| 157 | |
| 158 size_t GetSize() const | |
| 159 { | |
| 160 return size_; | |
| 161 } | |
| 162 | |
|
248
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
163 void ReadWhole(std::string& target) |
| 0 | 164 { |
|
248
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
165 if (target.size() != size_) |
| 0 | 166 { |
|
248
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
167 throw Orthanc::OrthancException(Orthanc::ErrorCode_InternalError); |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
168 } |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
169 |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
170 PGconn* pg = reinterpret_cast<PGconn*>(database_.pg_); |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
171 |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
172 // Go to the first byte of the object |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
173 lo_lseek(pg, fd_, 0, SEEK_SET); |
| 0 | 174 |
|
248
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
175 ReadInternal(pg, target); |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
176 } |
| 0 | 177 |
|
248
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
178 void ReadRange(std::string& target, |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
179 uint64_t start) |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
180 { |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
181 PGconn* pg = reinterpret_cast<PGconn*>(database_.pg_); |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
182 |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
183 // Go to the first byte of the object |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
184 lo_lseek(pg, fd_, start, SEEK_SET); |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
185 |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
186 ReadInternal(pg, target); |
| 0 | 187 } |
| 188 }; | |
| 189 | |
| 190 | |
|
248
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
191 void PostgreSQLLargeObject::ReadWhole(std::string& target, |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
192 PostgreSQLDatabase& database, |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
193 const std::string& oid) |
| 0 | 194 { |
| 195 Reader reader(database, oid); | |
| 196 target.resize(reader.GetSize()); | |
| 197 | |
| 198 if (target.size() > 0) | |
| 199 { | |
|
248
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
200 reader.ReadWhole(target); |
| 0 | 201 } |
| 202 } | |
| 203 | |
| 204 | |
|
248
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
205 void PostgreSQLLargeObject::ReadRange(std::string& target, |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
206 PostgreSQLDatabase& database, |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
207 const std::string& oid, |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
208 uint64_t start, |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
209 size_t length) |
| 0 | 210 { |
| 211 Reader reader(database, oid); | |
| 212 | |
|
248
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
213 if (start >= reader.GetSize() || |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
214 start + length > reader.GetSize()) |
| 0 | 215 { |
|
248
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
216 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadRange); |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
217 } |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
218 |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
219 target.resize(length); |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
220 |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
221 if (target.size() > 0) |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
222 { |
|
7a4f9bcb0bc2
PostgreSQL: Support of range reads from the storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
223 reader.ReadRange(target, start); |
| 0 | 224 } |
| 225 } | |
| 226 | |
| 227 | |
| 228 std::string PostgreSQLLargeObject::GetOid() const | |
| 229 { | |
| 230 return boost::lexical_cast<std::string>(oid_); | |
| 231 } | |
| 232 | |
| 233 | |
| 234 void PostgreSQLLargeObject::Delete(PostgreSQLDatabase& database, | |
| 235 const std::string& oid) | |
| 236 { | |
| 237 PGconn* pg = reinterpret_cast<PGconn*>(database.pg_); | |
| 238 Oid id = boost::lexical_cast<Oid>(oid); | |
| 239 | |
| 240 if (lo_unlink(pg, id) < 0) | |
| 241 { | |
| 242 LOG(ERROR) << "PostgreSQL: Unable to delete the large object from the database"; | |
| 243 database.ThrowException(false); | |
| 244 } | |
| 245 } | |
| 246 } |