Mercurial > hg > orthanc-databases
annotate SQLite/Plugins/SQLiteIndex.cpp @ 157:275e14f57f1e
replacing deprecated std::auto_ptr by std::unique_ptr
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Mon, 06 Jul 2020 12:45:58 +0200 |
| parents | 063aa53b5917 |
| children | 3236894320d6 |
| 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 | |
|
140
4cd7e45b671e
upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
85
diff
changeset
|
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium |
| 0 | 6 * |
| 7 * This program is free software: you can redistribute it and/or | |
| 8 * modify it under the terms of the GNU Affero General Public License | |
| 9 * as published by the Free Software Foundation, either version 3 of | |
| 10 * the License, or (at your option) any later version. | |
| 11 * | |
| 12 * This program is distributed in the hope that it will be useful, but | |
| 13 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 15 * Affero General Public License for more details. | |
| 16 * | |
| 17 * You should have received a copy of the GNU Affero General Public License | |
| 18 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 19 **/ | |
| 20 | |
| 21 | |
| 22 #include "SQLiteIndex.h" | |
| 23 | |
|
85
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
24 #include "../../Framework/Common/Integer64Value.h" |
| 0 | 25 #include "../../Framework/Plugins/GlobalProperties.h" |
| 26 #include "../../Framework/SQLite/SQLiteDatabase.h" | |
| 27 #include "../../Framework/SQLite/SQLiteTransaction.h" | |
| 28 | |
| 29 #include <EmbeddedResources.h> // Auto-generated file | |
| 30 | |
|
157
275e14f57f1e
replacing deprecated std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
152
diff
changeset
|
31 #include <Compatibility.h> // For std::unique_ptr<> |
| 152 | 32 #include <Logging.h> |
| 33 #include <OrthancException.h> | |
| 0 | 34 |
| 35 namespace OrthancDatabases | |
| 36 { | |
| 37 IDatabase* SQLiteIndex::OpenInternal() | |
| 38 { | |
| 39 uint32_t expectedVersion = 6; | |
| 40 if (context_) | |
| 41 { | |
| 42 expectedVersion = OrthancPluginGetExpectedDatabaseVersion(context_); | |
| 43 } | |
| 44 else | |
| 45 { | |
| 46 // This case only occurs during unit testing | |
| 47 expectedVersion = 6; | |
| 48 } | |
| 49 | |
| 50 // Check the expected version of the database | |
| 51 if (expectedVersion != 6) | |
| 52 { | |
| 53 LOG(ERROR) << "This database plugin is incompatible with your version of Orthanc " | |
| 54 << "expecting the DB schema version " << expectedVersion | |
| 55 << ", but this plugin is only compatible with version 6"; | |
| 56 throw Orthanc::OrthancException(Orthanc::ErrorCode_Plugin); | |
| 57 } | |
| 58 | |
| 59 | |
|
157
275e14f57f1e
replacing deprecated std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
152
diff
changeset
|
60 std::unique_ptr<SQLiteDatabase> db(new SQLiteDatabase); |
| 0 | 61 |
| 62 if (path_.empty()) | |
| 63 { | |
| 64 db->OpenInMemory(); | |
| 65 } | |
| 66 else | |
| 67 { | |
| 68 db->Open(path_); | |
| 69 } | |
| 70 | |
| 71 { | |
| 72 SQLiteTransaction t(*db); | |
| 73 | |
| 74 if (!db->DoesTableExist("Resources")) | |
| 75 { | |
| 76 std::string query; | |
| 77 | |
| 78 Orthanc::EmbeddedResources::GetFileResource | |
| 79 (query, Orthanc::EmbeddedResources::SQLITE_PREPARE_INDEX); | |
| 80 db->Execute(query); | |
| 81 | |
| 82 SetGlobalIntegerProperty(*db, t, Orthanc::GlobalProperty_DatabaseSchemaVersion, expectedVersion); | |
| 83 SetGlobalIntegerProperty(*db, t, Orthanc::GlobalProperty_DatabasePatchLevel, 1); | |
| 84 } | |
| 85 | |
| 86 t.Commit(); | |
| 87 } | |
| 88 | |
| 89 db->Execute("PRAGMA ENCODING=\"UTF-8\";"); | |
| 90 | |
| 91 if (fast_) | |
| 92 { | |
| 93 // Performance tuning of SQLite with PRAGMAs | |
| 94 // http://www.sqlite.org/pragma.html | |
| 95 db->Execute("PRAGMA SYNCHRONOUS=NORMAL;"); | |
| 96 db->Execute("PRAGMA JOURNAL_MODE=WAL;"); | |
| 97 db->Execute("PRAGMA LOCKING_MODE=EXCLUSIVE;"); | |
| 98 db->Execute("PRAGMA WAL_AUTOCHECKPOINT=1000;"); | |
| 99 //db->Execute("PRAGMA TEMP_STORE=memory"); | |
| 100 } | |
| 101 | |
| 102 { | |
| 103 SQLiteTransaction t(*db); | |
| 104 | |
| 105 if (!db->DoesTableExist("Resources")) | |
| 106 { | |
| 107 LOG(ERROR) << "Corrupted SQLite database"; | |
| 108 throw Orthanc::OrthancException(Orthanc::ErrorCode_InternalError); | |
| 109 } | |
| 110 | |
| 111 int version = 0; | |
| 112 if (!LookupGlobalIntegerProperty(version, *db, t, Orthanc::GlobalProperty_DatabaseSchemaVersion) || | |
| 113 version != 6) | |
| 114 { | |
| 115 LOG(ERROR) << "SQLite plugin is incompatible with database schema version: " << version; | |
| 116 throw Orthanc::OrthancException(Orthanc::ErrorCode_Database); | |
| 117 } | |
| 118 | |
| 119 int revision; | |
| 120 if (!LookupGlobalIntegerProperty(revision, *db, t, Orthanc::GlobalProperty_DatabasePatchLevel)) | |
| 121 { | |
| 122 revision = 1; | |
| 123 SetGlobalIntegerProperty(*db, t, Orthanc::GlobalProperty_DatabasePatchLevel, revision); | |
| 124 } | |
| 125 | |
| 126 if (revision != 1) | |
| 127 { | |
| 128 LOG(ERROR) << "SQLite plugin is incompatible with database schema revision: " << revision; | |
| 129 throw Orthanc::OrthancException(Orthanc::ErrorCode_Database); | |
| 130 } | |
| 131 | |
| 132 t.Commit(); | |
| 133 } | |
| 134 | |
| 135 return db.release(); | |
| 136 } | |
| 137 | |
| 138 | |
| 139 SQLiteIndex::SQLiteIndex(const std::string& path) : | |
| 140 IndexBackend(new Factory(*this)), | |
| 141 context_(NULL), | |
| 142 path_(path), | |
| 143 fast_(true) | |
| 144 { | |
| 145 if (path.empty()) | |
| 146 { | |
| 147 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
| 148 } | |
| 149 } | |
| 150 | |
| 151 | |
| 152 SQLiteIndex::SQLiteIndex() : | |
| 153 IndexBackend(new Factory(*this)), | |
| 154 context_(NULL), | |
| 155 fast_(true) | |
| 156 { | |
| 157 } | |
| 158 | |
| 159 | |
| 160 int64_t SQLiteIndex::CreateResource(const char* publicId, | |
| 161 OrthancPluginResourceType type) | |
| 162 { | |
| 163 DatabaseManager::CachedStatement statement( | |
| 164 STATEMENT_FROM_HERE, GetManager(), | |
| 165 "INSERT INTO Resources VALUES(NULL, ${type}, ${id}, NULL)"); | |
| 166 | |
| 167 statement.SetParameterType("id", ValueType_Utf8String); | |
| 168 statement.SetParameterType("type", ValueType_Integer64); | |
| 169 | |
| 170 Dictionary args; | |
| 171 args.SetUtf8Value("id", publicId); | |
| 172 args.SetIntegerValue("type", static_cast<int>(type)); | |
| 173 | |
| 174 statement.Execute(args); | |
| 175 | |
| 176 return dynamic_cast<SQLiteDatabase&>(statement.GetDatabase()).GetLastInsertRowId(); | |
| 177 } | |
|
85
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
178 |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
179 |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
180 int64_t SQLiteIndex::GetLastChangeIndex() |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
181 { |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
182 DatabaseManager::CachedStatement statement( |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
183 STATEMENT_FROM_HERE, GetManager(), |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
184 "SELECT seq FROM sqlite_sequence WHERE name='Changes'"); |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
185 |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
186 statement.SetReadOnly(true); |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
187 statement.Execute(); |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
188 |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
189 if (statement.IsDone()) |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
190 { |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
191 // No change has been recorded so far in the database |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
192 return 0; |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
193 } |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
194 else |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
195 { |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
196 const IValue& value = statement.GetResultField(0); |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
197 |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
198 switch (value.GetType()) |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
199 { |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
200 case ValueType_Integer64: |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
201 return dynamic_cast<const Integer64Value&>(value).GetValue(); |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
202 |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
203 default: |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
204 //LOG(ERROR) << value.Format(); |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
205 throw Orthanc::OrthancException(Orthanc::ErrorCode_InternalError); |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
206 } |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
207 } |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
208 } |
| 0 | 209 } |