Mercurial > hg > orthanc
annotate OrthancFramework/Sources/SQLite/Connection.h @ 4829:c847b0dfd255
added missing copyright headers
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Thu, 25 Nov 2021 18:53:08 +0100 |
parents | 50b0c69b653a |
children | 7053502fbf97 |
rev | line source |
---|---|
0 | 1 /** |
59 | 2 * Orthanc - A Lightweight, RESTful DICOM Store |
1220
9b9026560a5f
SQLite wrapper is now fully independent of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
3 * |
3063 | 4 * Copyright (C) 2012-2016 Sebastien Jodogne <s.jodogne@orthanc-labs.com>, |
1220
9b9026560a5f
SQLite wrapper is now fully independent of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
5 * Medical Physics Department, CHU of Liege, Belgium |
4829
c847b0dfd255
added missing copyright headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4304
diff
changeset
|
6 * Copyright (C) 2017-2021 Osimis S.A., Belgium |
0 | 7 * |
17 | 8 * Copyright (c) 2012 The Chromium Authors. All rights reserved. |
9 * | |
10 * Redistribution and use in source and binary forms, with or without | |
11 * modification, are permitted provided that the following conditions are | |
12 * met: | |
0 | 13 * |
17 | 14 * * Redistributions of source code must retain the above copyright |
15 * notice, this list of conditions and the following disclaimer. | |
16 * * Redistributions in binary form must reproduce the above | |
17 * copyright notice, this list of conditions and the following disclaimer | |
18 * in the documentation and/or other materials provided with the | |
19 * distribution. | |
20 * * Neither the name of Google Inc., the name of the CHU of Liege, | |
21 * nor the names of its contributors may be used to endorse or promote | |
22 * products derived from this software without specific prior written | |
23 * permission. | |
24 * | |
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | |
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
0 | 36 **/ |
37 | |
38 | |
39 #pragma once | |
40 | |
41 #include "Statement.h" | |
42 #include "IScalarFunction.h" | |
2302
f31dfb131dee
fix backward compatibility with SQLite < 3.19.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1900
diff
changeset
|
43 #include "SQLiteTypes.h" |
0 | 44 |
45 #include <string> | |
46 #include <map> | |
47 | |
1672
4c5a85c3ff43
sample database plugin now working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1291
diff
changeset
|
48 #define SQLITE_FROM_HERE ::Orthanc::SQLite::StatementId(__FILE__, __LINE__) |
0 | 49 |
59 | 50 namespace Orthanc |
0 | 51 { |
52 namespace SQLite | |
53 { | |
3992
f9863630ec7f
working on the shared library for Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3063
diff
changeset
|
54 class ORTHANC_PUBLIC Connection : NonCopyable |
0 | 55 { |
56 friend class Statement; | |
57 friend class Transaction; | |
58 | |
59 private: | |
60 // All cached statements. Keeping a reference to these statements means that | |
61 // they'll remain active. | |
62 typedef std::map<StatementId, StatementReference*> CachedStatements; | |
63 CachedStatements cachedStatements_; | |
64 | |
65 // The actual sqlite database. Will be NULL before Init has been called or if | |
66 // Init resulted in an error. | |
67 sqlite3* db_; | |
68 | |
69 // Number of currently-nested transactions. | |
70 int transactionNesting_; | |
71 | |
72 // True if any of the currently nested transactions have been rolled back. | |
73 // When we get to the outermost transaction, this will determine if we do | |
74 // a rollback instead of a commit. | |
75 bool needsRollback_; | |
76 | |
77 void ClearCache(); | |
78 | |
79 void CheckIsOpen() const; | |
80 | |
81 sqlite3* GetWrappedObject() | |
82 { | |
83 return db_; | |
84 } | |
85 | |
86 StatementReference& GetCachedStatement(const StatementId& id, | |
87 const char* sql); | |
88 | |
89 bool DoesTableOrIndexExist(const char* name, | |
90 const char* type) const; | |
91 | |
92 void DoRollback(); | |
93 | |
94 public: | |
95 // The database is opened by calling Open[InMemory](). Any uncommitted | |
96 // transactions will be rolled back when this object is deleted. | |
97 Connection(); | |
98 ~Connection(); | |
99 | |
100 void Open(const std::string& path); | |
101 | |
102 void OpenInMemory(); | |
103 | |
104 void Close(); | |
105 | |
106 bool Execute(const char* sql); | |
107 | |
4304 | 108 bool Execute(const std::string& sql); |
0 | 109 |
206
4453a010d0db
flush to disk thread
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
59
diff
changeset
|
110 void FlushToDisk(); |
4453a010d0db
flush to disk thread
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
59
diff
changeset
|
111 |
0 | 112 IScalarFunction* Register(IScalarFunction* func); // Takes the ownership of the function |
113 | |
114 // Info querying ------------------------------------------------------------- | |
115 | |
116 // Used to check a |sql| statement for syntactic validity. If the | |
117 // statement is valid SQL, returns true. | |
118 bool IsSQLValid(const char* sql); | |
119 | |
120 // Returns true if the given table exists. | |
121 bool DoesTableExist(const char* table_name) const; | |
122 | |
123 // Returns true if the given index exists. | |
124 bool DoesIndexExist(const char* index_name) const; | |
125 | |
126 // Returns true if a column with the given name exists in the given table. | |
127 bool DoesColumnExist(const char* table_name, const char* column_name) const; | |
128 | |
129 // Returns sqlite's internal ID for the last inserted row. Valid only | |
130 // immediately after an insert. | |
131 int64_t GetLastInsertRowId() const; | |
132 | |
133 // Returns sqlite's count of the number of rows modified by the last | |
134 // statement executed. Will be 0 if no statement has executed or the database | |
135 // is closed. | |
136 int GetLastChangeCount() const; | |
137 | |
138 // Errors -------------------------------------------------------------------- | |
139 | |
140 // Returns the error code associated with the last sqlite operation. | |
141 int GetErrorCode() const; | |
142 | |
143 // Returns the errno associated with GetErrorCode(). See | |
144 // SQLITE_LAST_ERRNO in SQLite documentation. | |
145 int GetLastErrno() const; | |
146 | |
147 // Returns a pointer to a statically allocated string associated with the | |
148 // last sqlite operation. | |
149 const char* GetErrorMessage() const; | |
150 | |
151 | |
152 // Diagnostics (for unit tests) ---------------------------------------------- | |
153 | |
154 int ExecuteAndReturnErrorCode(const char* sql); | |
155 | |
4304 | 156 bool HasCachedStatement(const StatementId& id) const; |
0 | 157 |
4304 | 158 int GetTransactionNesting() const; |
0 | 159 |
160 // Transactions -------------------------------------------------------------- | |
161 | |
162 bool BeginTransaction(); | |
163 void RollbackTransaction(); | |
206
4453a010d0db
flush to disk thread
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
59
diff
changeset
|
164 bool CommitTransaction(); |
0 | 165 }; |
166 } | |
167 } |