Mercurial > hg > orthanc-databases
annotate SQLite/Plugins/SQLiteIndex.cpp @ 152:063aa53b5917
sync
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Wed, 01 Jul 2020 08:54:32 +0200 |
| parents | 4cd7e45b671e |
| children | 275e14f57f1e |
| 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 | |
| 152 | 31 #include <Logging.h> |
| 32 #include <OrthancException.h> | |
| 0 | 33 |
| 34 namespace OrthancDatabases | |
| 35 { | |
| 36 IDatabase* SQLiteIndex::OpenInternal() | |
| 37 { | |
| 38 uint32_t expectedVersion = 6; | |
| 39 if (context_) | |
| 40 { | |
| 41 expectedVersion = OrthancPluginGetExpectedDatabaseVersion(context_); | |
| 42 } | |
| 43 else | |
| 44 { | |
| 45 // This case only occurs during unit testing | |
| 46 expectedVersion = 6; | |
| 47 } | |
| 48 | |
| 49 // Check the expected version of the database | |
| 50 if (expectedVersion != 6) | |
| 51 { | |
| 52 LOG(ERROR) << "This database plugin is incompatible with your version of Orthanc " | |
| 53 << "expecting the DB schema version " << expectedVersion | |
| 54 << ", but this plugin is only compatible with version 6"; | |
| 55 throw Orthanc::OrthancException(Orthanc::ErrorCode_Plugin); | |
| 56 } | |
| 57 | |
| 58 | |
| 59 std::auto_ptr<SQLiteDatabase> db(new SQLiteDatabase); | |
| 60 | |
| 61 if (path_.empty()) | |
| 62 { | |
| 63 db->OpenInMemory(); | |
| 64 } | |
| 65 else | |
| 66 { | |
| 67 db->Open(path_); | |
| 68 } | |
| 69 | |
| 70 { | |
| 71 SQLiteTransaction t(*db); | |
| 72 | |
| 73 if (!db->DoesTableExist("Resources")) | |
| 74 { | |
| 75 std::string query; | |
| 76 | |
| 77 Orthanc::EmbeddedResources::GetFileResource | |
| 78 (query, Orthanc::EmbeddedResources::SQLITE_PREPARE_INDEX); | |
| 79 db->Execute(query); | |
| 80 | |
| 81 SetGlobalIntegerProperty(*db, t, Orthanc::GlobalProperty_DatabaseSchemaVersion, expectedVersion); | |
| 82 SetGlobalIntegerProperty(*db, t, Orthanc::GlobalProperty_DatabasePatchLevel, 1); | |
| 83 } | |
| 84 | |
| 85 t.Commit(); | |
| 86 } | |
| 87 | |
| 88 db->Execute("PRAGMA ENCODING=\"UTF-8\";"); | |
| 89 | |
| 90 if (fast_) | |
| 91 { | |
| 92 // Performance tuning of SQLite with PRAGMAs | |
| 93 // http://www.sqlite.org/pragma.html | |
| 94 db->Execute("PRAGMA SYNCHRONOUS=NORMAL;"); | |
| 95 db->Execute("PRAGMA JOURNAL_MODE=WAL;"); | |
| 96 db->Execute("PRAGMA LOCKING_MODE=EXCLUSIVE;"); | |
| 97 db->Execute("PRAGMA WAL_AUTOCHECKPOINT=1000;"); | |
| 98 //db->Execute("PRAGMA TEMP_STORE=memory"); | |
| 99 } | |
| 100 | |
| 101 { | |
| 102 SQLiteTransaction t(*db); | |
| 103 | |
| 104 if (!db->DoesTableExist("Resources")) | |
| 105 { | |
| 106 LOG(ERROR) << "Corrupted SQLite database"; | |
| 107 throw Orthanc::OrthancException(Orthanc::ErrorCode_InternalError); | |
| 108 } | |
| 109 | |
| 110 int version = 0; | |
| 111 if (!LookupGlobalIntegerProperty(version, *db, t, Orthanc::GlobalProperty_DatabaseSchemaVersion) || | |
| 112 version != 6) | |
| 113 { | |
| 114 LOG(ERROR) << "SQLite plugin is incompatible with database schema version: " << version; | |
| 115 throw Orthanc::OrthancException(Orthanc::ErrorCode_Database); | |
| 116 } | |
| 117 | |
| 118 int revision; | |
| 119 if (!LookupGlobalIntegerProperty(revision, *db, t, Orthanc::GlobalProperty_DatabasePatchLevel)) | |
| 120 { | |
| 121 revision = 1; | |
| 122 SetGlobalIntegerProperty(*db, t, Orthanc::GlobalProperty_DatabasePatchLevel, revision); | |
| 123 } | |
| 124 | |
| 125 if (revision != 1) | |
| 126 { | |
| 127 LOG(ERROR) << "SQLite plugin is incompatible with database schema revision: " << revision; | |
| 128 throw Orthanc::OrthancException(Orthanc::ErrorCode_Database); | |
| 129 } | |
| 130 | |
| 131 t.Commit(); | |
| 132 } | |
| 133 | |
| 134 return db.release(); | |
| 135 } | |
| 136 | |
| 137 | |
| 138 SQLiteIndex::SQLiteIndex(const std::string& path) : | |
| 139 IndexBackend(new Factory(*this)), | |
| 140 context_(NULL), | |
| 141 path_(path), | |
| 142 fast_(true) | |
| 143 { | |
| 144 if (path.empty()) | |
| 145 { | |
| 146 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
| 147 } | |
| 148 } | |
| 149 | |
| 150 | |
| 151 SQLiteIndex::SQLiteIndex() : | |
| 152 IndexBackend(new Factory(*this)), | |
| 153 context_(NULL), | |
| 154 fast_(true) | |
| 155 { | |
| 156 } | |
| 157 | |
| 158 | |
| 159 int64_t SQLiteIndex::CreateResource(const char* publicId, | |
| 160 OrthancPluginResourceType type) | |
| 161 { | |
| 162 DatabaseManager::CachedStatement statement( | |
| 163 STATEMENT_FROM_HERE, GetManager(), | |
| 164 "INSERT INTO Resources VALUES(NULL, ${type}, ${id}, NULL)"); | |
| 165 | |
| 166 statement.SetParameterType("id", ValueType_Utf8String); | |
| 167 statement.SetParameterType("type", ValueType_Integer64); | |
| 168 | |
| 169 Dictionary args; | |
| 170 args.SetUtf8Value("id", publicId); | |
| 171 args.SetIntegerValue("type", static_cast<int>(type)); | |
| 172 | |
| 173 statement.Execute(args); | |
| 174 | |
| 175 return dynamic_cast<SQLiteDatabase&>(statement.GetDatabase()).GetLastInsertRowId(); | |
| 176 } | |
|
85
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
177 |
|
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 int64_t SQLiteIndex::GetLastChangeIndex() |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
180 { |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
181 DatabaseManager::CachedStatement statement( |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
182 STATEMENT_FROM_HERE, GetManager(), |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
183 "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
|
184 |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
185 statement.SetReadOnly(true); |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
186 statement.Execute(); |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
187 |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
188 if (statement.IsDone()) |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
189 { |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
190 // 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
|
191 return 0; |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
192 } |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
193 else |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
194 { |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
195 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
|
196 |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
197 switch (value.GetType()) |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
198 { |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
199 case ValueType_Integer64: |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
200 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
|
201 |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
202 default: |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
203 //LOG(ERROR) << value.Format(); |
|
1012fe77241c
new extension implemented for PostgreSQL and SQLite: GetLastChangeIndex
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
204 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
|
205 } |
|
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 } |
| 0 | 208 } |