Mercurial > hg > orthanc
annotate OrthancServer/IDatabaseWrapper.h @ 3061:ce272138f15e db-changes
integration mainline->db-changes
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Mon, 24 Dec 2018 11:39:33 +0100 |
| parents | 6c5d4281da4a 4e43e67f8ecf |
| children | ead8576a02ef |
| rev | line source |
|---|---|
| 1247 | 1 /** |
| 2 * Orthanc - A Lightweight, RESTful DICOM Store | |
| 1900 | 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics |
|
1288
6e7e5ed91c2d
upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1286
diff
changeset
|
4 * Department, University Hospital of Liege, Belgium |
|
3060
4e43e67f8ecf
preparing for 2019
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2697
diff
changeset
|
5 * Copyright (C) 2017-2019 Osimis S.A., Belgium |
| 1247 | 6 * |
| 7 * This program is free software: you can redistribute it and/or | |
| 8 * modify it under the terms of the GNU General Public License as | |
| 9 * published by the Free Software Foundation, either version 3 of the | |
| 10 * License, or (at your option) any later version. | |
| 11 * | |
| 12 * In addition, as a special exception, the copyright holders of this | |
| 13 * program give permission to link the code of its release with the | |
| 14 * OpenSSL project's "OpenSSL" library (or with modified versions of it | |
| 15 * that use the same license as the "OpenSSL" library), and distribute | |
| 16 * the linked executables. You must obey the GNU General Public License | |
| 17 * in all respects for all of the code used other than "OpenSSL". If you | |
| 18 * modify file(s) with this exception, you may extend this exception to | |
| 19 * your version of the file(s), but you are not obligated to do so. If | |
| 20 * you do not wish to do so, delete this exception statement from your | |
| 21 * version. If you delete this exception statement from all source files | |
| 22 * in the program, then also delete it here. | |
| 23 * | |
| 24 * This program is distributed in the hope that it will be useful, but | |
| 25 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 27 * General Public License for more details. | |
| 28 * | |
| 29 * You should have received a copy of the GNU General Public License | |
| 30 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 31 **/ | |
| 32 | |
| 33 | |
| 34 #pragma once | |
| 35 | |
| 36 #include "../Core/DicomFormat/DicomMap.h" | |
|
3025
039a9d262d64
preparing to speed up find in databases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3020
diff
changeset
|
37 #include "../Core/FileStorage/FileInfo.h" |
|
1615
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1509
diff
changeset
|
38 #include "../Core/FileStorage/IStorageArea.h" |
|
3025
039a9d262d64
preparing to speed up find in databases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3020
diff
changeset
|
39 #include "../Core/SQLite/ITransaction.h" |
|
039a9d262d64
preparing to speed up find in databases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3020
diff
changeset
|
40 |
|
039a9d262d64
preparing to speed up find in databases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3020
diff
changeset
|
41 #include "ExportedResource.h" |
|
1432
0ac74fa21db8
rename IServerIndexListener as IDatabaseListener
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1306
diff
changeset
|
42 #include "IDatabaseListener.h" |
|
3029
ea653ec47f31
new class: DatabaseConstraint
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3027
diff
changeset
|
43 #include "Search/DatabaseConstraint.h" |
|
3025
039a9d262d64
preparing to speed up find in databases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3020
diff
changeset
|
44 #include "Search/DatabaseLookup.h" |
| 1247 | 45 |
| 46 #include <list> | |
| 47 #include <boost/noncopyable.hpp> | |
| 48 | |
| 49 namespace Orthanc | |
| 50 { | |
| 51 class IDatabaseWrapper : public boost::noncopyable | |
| 52 { | |
| 53 public: | |
|
3019
8336204d95dc
refactoring computation of disk size for recycling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2697
diff
changeset
|
54 class ITransaction : public boost::noncopyable |
|
8336204d95dc
refactoring computation of disk size for recycling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2697
diff
changeset
|
55 { |
|
8336204d95dc
refactoring computation of disk size for recycling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2697
diff
changeset
|
56 public: |
|
8336204d95dc
refactoring computation of disk size for recycling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2697
diff
changeset
|
57 virtual ~ITransaction() |
|
8336204d95dc
refactoring computation of disk size for recycling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2697
diff
changeset
|
58 { |
|
8336204d95dc
refactoring computation of disk size for recycling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2697
diff
changeset
|
59 } |
|
8336204d95dc
refactoring computation of disk size for recycling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2697
diff
changeset
|
60 |
|
8336204d95dc
refactoring computation of disk size for recycling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2697
diff
changeset
|
61 virtual void Begin() = 0; |
|
8336204d95dc
refactoring computation of disk size for recycling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2697
diff
changeset
|
62 |
|
8336204d95dc
refactoring computation of disk size for recycling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2697
diff
changeset
|
63 virtual void Rollback() = 0; |
|
8336204d95dc
refactoring computation of disk size for recycling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2697
diff
changeset
|
64 |
|
8336204d95dc
refactoring computation of disk size for recycling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2697
diff
changeset
|
65 virtual void Commit(int64_t fileSizeDelta) = 0; |
|
8336204d95dc
refactoring computation of disk size for recycling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2697
diff
changeset
|
66 }; |
|
8336204d95dc
refactoring computation of disk size for recycling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2697
diff
changeset
|
67 |
|
8336204d95dc
refactoring computation of disk size for recycling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2697
diff
changeset
|
68 |
| 1247 | 69 virtual ~IDatabaseWrapper() |
| 70 { | |
| 71 } | |
| 72 | |
|
1672
4c5a85c3ff43
sample database plugin now working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1668
diff
changeset
|
73 virtual void Open() = 0; |
|
4c5a85c3ff43
sample database plugin now working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1668
diff
changeset
|
74 |
|
4c5a85c3ff43
sample database plugin now working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1668
diff
changeset
|
75 virtual void Close() = 0; |
|
4c5a85c3ff43
sample database plugin now working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1668
diff
changeset
|
76 |
| 1247 | 77 virtual void AddAttachment(int64_t id, |
| 78 const FileInfo& attachment) = 0; | |
| 79 | |
| 80 virtual void AttachChild(int64_t parent, | |
| 81 int64_t child) = 0; | |
| 82 | |
| 1286 | 83 virtual void ClearChanges() = 0; |
| 84 | |
| 85 virtual void ClearExportedResources() = 0; | |
| 1247 | 86 |
| 87 virtual int64_t CreateResource(const std::string& publicId, | |
| 88 ResourceType type) = 0; | |
| 89 | |
| 90 virtual void DeleteAttachment(int64_t id, | |
| 91 FileContentType attachment) = 0; | |
| 92 | |
| 93 virtual void DeleteMetadata(int64_t id, | |
| 94 MetadataType type) = 0; | |
| 95 | |
| 96 virtual void DeleteResource(int64_t id) = 0; | |
| 97 | |
| 98 virtual void FlushToDisk() = 0; | |
| 99 | |
|
1306
8cd5784a6d80
IDatabaseWrapper::HasFlushToDisk()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1302
diff
changeset
|
100 virtual bool HasFlushToDisk() const = 0; |
|
8cd5784a6d80
IDatabaseWrapper::HasFlushToDisk()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1302
diff
changeset
|
101 |
| 1301 | 102 virtual void GetAllMetadata(std::map<MetadataType, std::string>& target, |
| 1247 | 103 int64_t id) = 0; |
| 104 | |
| 105 virtual void GetAllPublicIds(std::list<std::string>& target, | |
| 106 ResourceType resourceType) = 0; | |
| 107 | |
|
1509
0586ed8897f1
limit and since arguments while retrieving DICOM resources in the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1432
diff
changeset
|
108 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
|
109 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
|
110 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
|
111 size_t limit) = 0; |
| 1247 | 112 |
| 113 virtual void GetChanges(std::list<ServerIndexChange>& target /*out*/, | |
| 114 bool& done /*out*/, | |
| 115 int64_t since, | |
| 1302 | 116 uint32_t maxResults) = 0; |
| 1247 | 117 |
| 1301 | 118 virtual void GetChildrenInternalId(std::list<int64_t>& target, |
| 1247 | 119 int64_t id) = 0; |
| 120 | |
| 1301 | 121 virtual void GetChildrenPublicId(std::list<std::string>& target, |
| 1247 | 122 int64_t id) = 0; |
| 123 | |
| 124 virtual void GetExportedResources(std::list<ExportedResource>& target /*out*/, | |
| 125 bool& done /*out*/, | |
| 126 int64_t since, | |
| 1302 | 127 uint32_t maxResults) = 0; |
| 1247 | 128 |
| 129 virtual void GetLastChange(std::list<ServerIndexChange>& target /*out*/) = 0; | |
| 130 | |
| 131 virtual void GetLastExportedResource(std::list<ExportedResource>& target /*out*/) = 0; | |
| 132 | |
| 133 virtual void GetMainDicomTags(DicomMap& map, | |
| 134 int64_t id) = 0; | |
| 135 | |
| 136 virtual std::string GetPublicId(int64_t resourceId) = 0; | |
| 137 | |
| 138 virtual uint64_t GetResourceCount(ResourceType resourceType) = 0; | |
| 139 | |
| 140 virtual ResourceType GetResourceType(int64_t resourceId) = 0; | |
| 141 | |
| 142 virtual uint64_t GetTotalCompressedSize() = 0; | |
| 143 | |
| 144 virtual uint64_t GetTotalUncompressedSize() = 0; | |
| 145 | |
| 146 virtual bool IsExistingResource(int64_t internalId) = 0; | |
| 147 | |
| 148 virtual bool IsProtectedPatient(int64_t internalId) = 0; | |
| 149 | |
| 150 virtual void ListAvailableMetadata(std::list<MetadataType>& target, | |
| 151 int64_t id) = 0; | |
| 152 | |
| 1301 | 153 virtual void ListAvailableAttachments(std::list<FileContentType>& target, |
| 1247 | 154 int64_t id) = 0; |
| 155 | |
| 156 virtual void LogChange(int64_t internalId, | |
| 157 const ServerIndexChange& change) = 0; | |
| 158 | |
| 159 virtual void LogExportedResource(const ExportedResource& resource) = 0; | |
| 160 | |
| 161 virtual bool LookupAttachment(FileInfo& attachment, | |
| 162 int64_t id, | |
| 163 FileContentType contentType) = 0; | |
| 164 | |
| 165 virtual bool LookupGlobalProperty(std::string& target, | |
| 166 GlobalProperty property) = 0; | |
| 167 | |
| 168 virtual bool LookupMetadata(std::string& target, | |
| 169 int64_t id, | |
| 170 MetadataType type) = 0; | |
| 171 | |
| 172 virtual bool LookupParent(int64_t& parentId, | |
| 173 int64_t resourceId) = 0; | |
| 174 | |
| 1294 | 175 virtual bool LookupResource(int64_t& id, |
| 176 ResourceType& type, | |
| 177 const std::string& publicId) = 0; | |
| 1247 | 178 |
| 179 virtual bool SelectPatientToRecycle(int64_t& internalId) = 0; | |
| 180 | |
| 181 virtual bool SelectPatientToRecycle(int64_t& internalId, | |
| 182 int64_t patientIdToAvoid) = 0; | |
| 183 | |
| 184 virtual void SetGlobalProperty(GlobalProperty property, | |
| 185 const std::string& value) = 0; | |
| 186 | |
|
1668
de1413733c97
reconstructing main dicom tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1615
diff
changeset
|
187 virtual void ClearMainDicomTags(int64_t id) = 0; |
|
de1413733c97
reconstructing main dicom tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1615
diff
changeset
|
188 |
| 1286 | 189 virtual void SetMainDicomTag(int64_t id, |
| 190 const DicomTag& tag, | |
| 191 const std::string& value) = 0; | |
| 1247 | 192 |
| 1713 | 193 virtual void SetIdentifierTag(int64_t id, |
| 194 const DicomTag& tag, | |
| 195 const std::string& value) = 0; | |
| 196 | |
| 1247 | 197 virtual void SetMetadata(int64_t id, |
| 198 MetadataType type, | |
| 199 const std::string& value) = 0; | |
| 200 | |
| 201 virtual void SetProtectedPatient(int64_t internalId, | |
| 202 bool isProtected) = 0; | |
| 203 | |
|
3019
8336204d95dc
refactoring computation of disk size for recycling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2697
diff
changeset
|
204 virtual ITransaction* StartTransaction() = 0; |
| 1247 | 205 |
|
1432
0ac74fa21db8
rename IServerIndexListener as IDatabaseListener
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1306
diff
changeset
|
206 virtual void SetListener(IDatabaseListener& listener) = 0; |
|
1615
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1509
diff
changeset
|
207 |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1509
diff
changeset
|
208 virtual unsigned int GetDatabaseVersion() = 0; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1509
diff
changeset
|
209 |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1509
diff
changeset
|
210 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
|
211 IStorageArea& storageArea) = 0; |
|
3020
d207f6ac1f86
tracking disk size by the database engine to ensure consistency across transactions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3019
diff
changeset
|
212 |
|
d207f6ac1f86
tracking disk size by the database engine to ensure consistency across transactions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3019
diff
changeset
|
213 virtual bool IsDiskSizeAbove(uint64_t threshold) = 0; |
|
3025
039a9d262d64
preparing to speed up find in databases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3020
diff
changeset
|
214 |
|
039a9d262d64
preparing to speed up find in databases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3020
diff
changeset
|
215 virtual void ApplyLookupResources(std::vector<std::string>& resourcesId, |
|
3036
8fd203510d8b
moving LookupIdentifierQuery to the graveyard
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3031
diff
changeset
|
216 std::vector<std::string>* instancesId, // Can be NULL if not needed |
|
3029
ea653ec47f31
new class: DatabaseConstraint
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3027
diff
changeset
|
217 const std::vector<DatabaseConstraint>& lookup, |
|
3025
039a9d262d64
preparing to speed up find in databases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3020
diff
changeset
|
218 ResourceType queryLevel, |
|
039a9d262d64
preparing to speed up find in databases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3020
diff
changeset
|
219 size_t limit) = 0; |
| 1247 | 220 }; |
| 221 } |