Mercurial > hg > orthanc
annotate OrthancServer/DatabaseWrapper.h @ 1664:0c58f189782d db-changes
prepare migration to db v6
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Wed, 30 Sep 2015 13:43:20 +0200 |
parents | c40fe92a68e7 |
children | de1413733c97 |
rev | line source |
---|---|
183 | 1 /** |
2 * Orthanc - A Lightweight, RESTful DICOM Store | |
1288
6e7e5ed91c2d
upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1286
diff
changeset
|
3 * Copyright (C) 2012-2015 Sebastien Jodogne, Medical Physics |
6e7e5ed91c2d
upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1286
diff
changeset
|
4 * Department, University Hospital of Liege, Belgium |
183 | 5 * |
6 * This program is free software: you can redistribute it and/or | |
7 * modify it under the terms of the GNU General Public License as | |
8 * published by the Free Software Foundation, either version 3 of the | |
9 * License, or (at your option) any later version. | |
10 * | |
11 * In addition, as a special exception, the copyright holders of this | |
12 * program give permission to link the code of its release with the | |
13 * OpenSSL project's "OpenSSL" library (or with modified versions of it | |
14 * that use the same license as the "OpenSSL" library), and distribute | |
15 * the linked executables. You must obey the GNU General Public License | |
16 * in all respects for all of the code used other than "OpenSSL". If you | |
17 * modify file(s) with this exception, you may extend this exception to | |
18 * your version of the file(s), but you are not obligated to do so. If | |
19 * you do not wish to do so, delete this exception statement from your | |
20 * version. If you delete this exception statement from all source files | |
21 * in the program, then also delete it here. | |
22 * | |
23 * This program is distributed in the hope that it will be useful, but | |
24 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
26 * General Public License for more details. | |
27 * | |
28 * You should have received a copy of the GNU General Public License | |
29 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
30 **/ | |
31 | |
32 | |
33 #pragma once | |
34 | |
1247 | 35 #include "IDatabaseWrapper.h" |
36 | |
183 | 37 #include "../Core/SQLite/Connection.h" |
187
8e673a65564d
refactoring of storing new instances
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
183
diff
changeset
|
38 #include "../Core/SQLite/Transaction.h" |
1242 | 39 |
183 | 40 namespace Orthanc |
41 { | |
42 namespace Internals | |
43 { | |
44 class SignalRemainingAncestor; | |
45 } | |
46 | |
47 /** | |
48 * This class manages an instance of the Orthanc SQLite database. It | |
49 * translates low-level requests into SQL statements. Mutual | |
50 * exclusion MUST be implemented at a higher level. | |
51 **/ | |
1247 | 52 class DatabaseWrapper : public IDatabaseWrapper |
183 | 53 { |
54 private: | |
1432
0ac74fa21db8
rename IServerIndexListener as IDatabaseListener
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1306
diff
changeset
|
55 IDatabaseListener* listener_; |
183 | 56 SQLite::Connection db_; |
57 Internals::SignalRemainingAncestor* signalRemainingAncestor_; | |
1615
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1509
diff
changeset
|
58 unsigned int version_; |
183 | 59 |
60 void Open(); | |
61 | |
1240 | 62 void GetChangesInternal(std::list<ServerIndexChange>& target, |
63 bool& done, | |
237
16a4ac70bd8a
last change and export
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
233
diff
changeset
|
64 SQLite::Statement& s, |
1302 | 65 uint32_t maxResults); |
237
16a4ac70bd8a
last change and export
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
233
diff
changeset
|
66 |
1244 | 67 void GetExportedResourcesInternal(std::list<ExportedResource>& target, |
68 bool& done, | |
742 | 69 SQLite::Statement& s, |
1302 | 70 uint32_t maxResults); |
237
16a4ac70bd8a
last change and export
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
233
diff
changeset
|
71 |
1286 | 72 void ClearTable(const std::string& tableName); |
73 | |
1664
0c58f189782d
prepare migration to db v6
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1615
diff
changeset
|
74 void ExecuteUpgrade5To6(IStorageArea& storageArea); |
0c58f189782d
prepare migration to db v6
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1615
diff
changeset
|
75 |
183 | 76 public: |
1247 | 77 DatabaseWrapper(const std::string& path); |
78 | |
79 DatabaseWrapper(); | |
80 | |
1432
0ac74fa21db8
rename IServerIndexListener as IDatabaseListener
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1306
diff
changeset
|
81 virtual void SetListener(IDatabaseListener& listener); |
183 | 82 |
1247 | 83 virtual void SetGlobalProperty(GlobalProperty property, |
84 const std::string& value); | |
183 | 85 |
1247 | 86 virtual bool LookupGlobalProperty(std::string& target, |
87 GlobalProperty property); | |
88 | |
89 virtual int64_t CreateResource(const std::string& publicId, | |
90 ResourceType type); | |
183 | 91 |
1294 | 92 virtual bool LookupResource(int64_t& id, |
93 ResourceType& type, | |
94 const std::string& publicId); | |
183 | 95 |
1247 | 96 virtual bool LookupParent(int64_t& parentId, |
97 int64_t resourceId); | |
198
663cc6c46d0a
before refactoring of ServerIndex::GetXXX
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
197
diff
changeset
|
98 |
1247 | 99 virtual std::string GetPublicId(int64_t resourceId); |
100 | |
101 virtual ResourceType GetResourceType(int64_t resourceId); | |
198
663cc6c46d0a
before refactoring of ServerIndex::GetXXX
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
197
diff
changeset
|
102 |
1247 | 103 virtual void AttachChild(int64_t parent, |
104 int64_t child); | |
304 | 105 |
1247 | 106 virtual void DeleteResource(int64_t id); |
183 | 107 |
1247 | 108 virtual void SetMetadata(int64_t id, |
109 MetadataType type, | |
110 const std::string& value); | |
111 | |
112 virtual void DeleteMetadata(int64_t id, | |
113 MetadataType type); | |
183 | 114 |
1247 | 115 virtual bool LookupMetadata(std::string& target, |
116 int64_t id, | |
117 MetadataType type); | |
183 | 118 |
1247 | 119 virtual void ListAvailableMetadata(std::list<MetadataType>& target, |
120 int64_t id); | |
438 | 121 |
1247 | 122 virtual void AddAttachment(int64_t id, |
123 const FileInfo& attachment); | |
183 | 124 |
1247 | 125 virtual void DeleteAttachment(int64_t id, |
126 FileContentType attachment); | |
127 | |
1301 | 128 virtual void ListAvailableAttachments(std::list<FileContentType>& target, |
1247 | 129 int64_t id); |
436
d51186bf7602
read access to metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
413
diff
changeset
|
130 |
1247 | 131 virtual bool LookupAttachment(FileInfo& attachment, |
132 int64_t id, | |
133 FileContentType contentType); | |
183 | 134 |
1286 | 135 virtual void SetMainDicomTag(int64_t id, |
136 const DicomTag& tag, | |
137 const std::string& value); | |
699
2929e17f8447
add attachments to resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
138 |
1247 | 139 virtual void GetMainDicomTags(DicomMap& map, |
440
23e5b35e3c5c
statistics for patient/studies/series/instances
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
438
diff
changeset
|
140 int64_t id); |
23e5b35e3c5c
statistics for patient/studies/series/instances
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
438
diff
changeset
|
141 |
1301 | 142 virtual void GetChildrenPublicId(std::list<std::string>& target, |
1247 | 143 int64_t id); |
200
9c58b2b03cf0
refactoring of read operations
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
199
diff
changeset
|
144 |
1301 | 145 virtual void GetChildrenInternalId(std::list<int64_t>& target, |
1247 | 146 int64_t id); |
183 | 147 |
1247 | 148 virtual void LogChange(int64_t internalId, |
149 const ServerIndexChange& change); | |
183 | 150 |
1247 | 151 virtual void GetChanges(std::list<ServerIndexChange>& target /*out*/, |
152 bool& done /*out*/, | |
153 int64_t since, | |
1302 | 154 uint32_t maxResults); |
183 | 155 |
1247 | 156 virtual void GetLastChange(std::list<ServerIndexChange>& target /*out*/); |
204 | 157 |
1247 | 158 virtual void LogExportedResource(const ExportedResource& resource); |
183 | 159 |
1247 | 160 virtual void GetExportedResources(std::list<ExportedResource>& target /*out*/, |
161 bool& done /*out*/, | |
162 int64_t since, | |
1302 | 163 uint32_t maxResults); |
237
16a4ac70bd8a
last change and export
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
233
diff
changeset
|
164 |
1247 | 165 virtual void GetLastExportedResource(std::list<ExportedResource>& target /*out*/); |
183 | 166 |
1247 | 167 virtual uint64_t GetTotalCompressedSize(); |
168 | |
169 virtual uint64_t GetTotalUncompressedSize(); | |
238 | 170 |
1247 | 171 virtual uint64_t GetResourceCount(ResourceType resourceType); |
190 | 172 |
1247 | 173 virtual void GetAllPublicIds(std::list<std::string>& target, |
174 ResourceType resourceType); | |
262
2354560daf2f
primitives for recycling patients
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
238
diff
changeset
|
175 |
1509
0586ed8897f1
limit and since arguments while retrieving DICOM resources in the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1432
diff
changeset
|
176 virtual void GetAllPublicIds(std::list<std::string>& target, |
0586ed8897f1
limit and since arguments while retrieving DICOM resources in the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1432
diff
changeset
|
177 ResourceType resourceType, |
0586ed8897f1
limit and since arguments while retrieving DICOM resources in the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1432
diff
changeset
|
178 size_t since, |
0586ed8897f1
limit and since arguments while retrieving DICOM resources in the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1432
diff
changeset
|
179 size_t limit); |
0586ed8897f1
limit and since arguments while retrieving DICOM resources in the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1432
diff
changeset
|
180 |
1247 | 181 virtual bool SelectPatientToRecycle(int64_t& internalId); |
262
2354560daf2f
primitives for recycling patients
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
238
diff
changeset
|
182 |
1247 | 183 virtual bool SelectPatientToRecycle(int64_t& internalId, |
184 int64_t patientIdToAvoid); | |
185 | |
186 virtual bool IsProtectedPatient(int64_t internalId); | |
262
2354560daf2f
primitives for recycling patients
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
238
diff
changeset
|
187 |
1247 | 188 virtual void SetProtectedPatient(int64_t internalId, |
189 bool isProtected); | |
183 | 190 |
1247 | 191 virtual SQLite::ITransaction* StartTransaction() |
187
8e673a65564d
refactoring of storing new instances
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
183
diff
changeset
|
192 { |
8e673a65564d
refactoring of storing new instances
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
183
diff
changeset
|
193 return new SQLite::Transaction(db_); |
8e673a65564d
refactoring of storing new instances
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
183
diff
changeset
|
194 } |
202 | 195 |
1247 | 196 virtual void FlushToDisk() |
206
4453a010d0db
flush to disk thread
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
204
diff
changeset
|
197 { |
4453a010d0db
flush to disk thread
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
204
diff
changeset
|
198 db_.FlushToDisk(); |
4453a010d0db
flush to disk thread
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
204
diff
changeset
|
199 } |
310 | 200 |
1306
8cd5784a6d80
IDatabaseWrapper::HasFlushToDisk()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1302
diff
changeset
|
201 virtual bool HasFlushToDisk() const |
8cd5784a6d80
IDatabaseWrapper::HasFlushToDisk()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1302
diff
changeset
|
202 { |
8cd5784a6d80
IDatabaseWrapper::HasFlushToDisk()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1302
diff
changeset
|
203 return true; |
8cd5784a6d80
IDatabaseWrapper::HasFlushToDisk()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1302
diff
changeset
|
204 } |
8cd5784a6d80
IDatabaseWrapper::HasFlushToDisk()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1302
diff
changeset
|
205 |
1286 | 206 virtual void ClearChanges() |
207 { | |
208 ClearTable("Changes"); | |
209 } | |
210 | |
211 virtual void ClearExportedResources() | |
212 { | |
213 ClearTable("ExportedResources"); | |
214 } | |
513 | 215 |
1247 | 216 virtual bool IsExistingResource(int64_t internalId); |
521 | 217 |
1301 | 218 virtual void LookupIdentifier(std::list<int64_t>& target, |
1247 | 219 const DicomTag& tag, |
220 const std::string& value); | |
521 | 221 |
1301 | 222 virtual void LookupIdentifier(std::list<int64_t>& target, |
1247 | 223 const std::string& value); |
1006
649d47854314
proper handling of metadata in Store
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
742
diff
changeset
|
224 |
1301 | 225 virtual void GetAllMetadata(std::map<MetadataType, std::string>& target, |
1247 | 226 int64_t id); |
1241 | 227 |
1615
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1509
diff
changeset
|
228 virtual unsigned int GetDatabaseVersion() |
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1509
diff
changeset
|
229 { |
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1509
diff
changeset
|
230 return version_; |
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1509
diff
changeset
|
231 } |
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1509
diff
changeset
|
232 |
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1509
diff
changeset
|
233 virtual void Upgrade(unsigned int targetVersion, |
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1509
diff
changeset
|
234 IStorageArea& storageArea); |
1241 | 235 |
236 | |
237 | |
238 /** | |
239 * The methods declared below are for unit testing only! | |
240 **/ | |
241 | |
1247 | 242 const char* GetErrorMessage() const |
243 { | |
244 return db_.GetErrorMessage(); | |
245 } | |
246 | |
1286 | 247 void GetChildren(std::list<std::string>& childrenPublicIds, |
248 int64_t id); | |
1241 | 249 |
1286 | 250 int64_t GetTableRecordCount(const std::string& table); |
1241 | 251 |
1301 | 252 bool GetParentPublicId(std::string& target, |
1286 | 253 int64_t id); |
1241 | 254 |
183 | 255 }; |
256 } |