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