Mercurial > hg > orthanc
annotate Core/SQLite/Statement.h @ 2044:0f35383dd6cc
doc
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Thu, 23 Jun 2016 17:32:01 +0200 |
| parents | b1291df2f780 |
| children | f31dfb131dee |
| 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:
724
diff
changeset
|
3 * |
| 1900 | 4 * Copyright (C) 2012-2016 Sebastien Jodogne <s.jodogne@gmail.com>, |
|
1220
9b9026560a5f
SQLite wrapper is now fully independent of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
724
diff
changeset
|
5 * Medical Physics Department, CHU of Liege, Belgium |
| 0 | 6 * |
| 17 | 7 * Copyright (c) 2012 The Chromium Authors. All rights reserved. |
| 8 * | |
| 9 * Redistribution and use in source and binary forms, with or without | |
| 10 * modification, are permitted provided that the following conditions are | |
| 11 * met: | |
| 0 | 12 * |
| 17 | 13 * * Redistributions of source code must retain the above copyright |
| 14 * notice, this list of conditions and the following disclaimer. | |
| 15 * * Redistributions in binary form must reproduce the above | |
| 16 * copyright notice, this list of conditions and the following disclaimer | |
| 17 * in the documentation and/or other materials provided with the | |
| 18 * distribution. | |
| 19 * * Neither the name of Google Inc., the name of the CHU of Liege, | |
| 20 * nor the names of its contributors may be used to endorse or promote | |
| 21 * products derived from this software without specific prior written | |
| 22 * permission. | |
| 23 * | |
| 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| 25 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| 26 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| 27 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| 28 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| 29 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | |
| 30 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |
| 31 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |
| 32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
| 33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
| 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| 0 | 35 **/ |
| 36 | |
| 37 | |
| 38 #pragma once | |
| 39 | |
|
1221
2255e66da726
getting rid of the dependency against Boost in the SQLite C++ wrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1220
diff
changeset
|
40 #include "NonCopyable.h" |
|
1220
9b9026560a5f
SQLite wrapper is now fully independent of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
724
diff
changeset
|
41 #include "OrthancSQLiteException.h" |
| 0 | 42 #include "StatementId.h" |
| 43 #include "StatementReference.h" | |
| 44 | |
| 45 #include <vector> | |
| 46 #include <stdint.h> | |
| 265 | 47 |
| 48 #if ORTHANC_BUILD_UNIT_TESTS == 1 | |
| 138 | 49 #include <gtest/gtest_prod.h> |
| 265 | 50 #endif |
| 0 | 51 |
| 52 struct sqlite3_stmt; | |
| 53 | |
| 54 | |
| 59 | 55 namespace Orthanc |
| 0 | 56 { |
| 57 namespace SQLite | |
| 58 { | |
| 59 class Connection; | |
| 60 | |
| 61 // Possible return values from ColumnType in a statement. These | |
| 62 // should match the values in sqlite3.h. | |
| 63 enum ColumnType | |
| 64 { | |
| 65 COLUMN_TYPE_INTEGER = 1, | |
| 66 COLUMN_TYPE_FLOAT = 2, | |
| 67 COLUMN_TYPE_TEXT = 3, | |
| 68 COLUMN_TYPE_BLOB = 4, | |
| 69 COLUMN_TYPE_NULL = 5 | |
| 70 }; | |
| 71 | |
|
1221
2255e66da726
getting rid of the dependency against Boost in the SQLite C++ wrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1220
diff
changeset
|
72 class Statement : public NonCopyable |
| 0 | 73 { |
| 74 friend class Connection; | |
| 265 | 75 |
| 76 #if ORTHANC_BUILD_UNIT_TESTS == 1 | |
| 138 | 77 FRIEND_TEST(SQLStatementTest, Run); |
| 78 FRIEND_TEST(SQLStatementTest, Reset); | |
| 265 | 79 #endif |
| 0 | 80 |
| 81 private: | |
| 82 StatementReference reference_; | |
| 83 | |
|
1582
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1291
diff
changeset
|
84 int CheckError(int err, |
|
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1291
diff
changeset
|
85 ErrorCode code) const; |
| 0 | 86 |
|
1582
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1291
diff
changeset
|
87 void CheckOk(int err, |
|
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1291
diff
changeset
|
88 ErrorCode code) const; |
| 0 | 89 |
| 90 struct sqlite3_stmt* GetStatement() const | |
| 91 { | |
| 92 return reference_.GetWrappedObject(); | |
| 93 } | |
| 94 | |
| 95 public: | |
| 96 Statement(Connection& database, | |
| 97 const std::string& sql); | |
| 98 | |
| 99 Statement(Connection& database, | |
| 100 const StatementId& id, | |
| 101 const std::string& sql); | |
| 102 | |
| 103 Statement(Connection& database, | |
| 104 const char* sql); | |
| 105 | |
| 106 Statement(Connection& database, | |
| 107 const StatementId& id, | |
| 108 const char* sql); | |
| 109 | |
|
137
0e97abc7b950
fix of a bug in older versions of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
80
diff
changeset
|
110 ~Statement() |
|
0e97abc7b950
fix of a bug in older versions of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
80
diff
changeset
|
111 { |
|
0e97abc7b950
fix of a bug in older versions of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
80
diff
changeset
|
112 Reset(); |
|
0e97abc7b950
fix of a bug in older versions of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
80
diff
changeset
|
113 } |
|
0e97abc7b950
fix of a bug in older versions of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
80
diff
changeset
|
114 |
| 0 | 115 bool Run(); |
| 116 | |
| 117 bool Step(); | |
| 118 | |
| 119 // Diagnostics -------------------------------------------------------------- | |
| 120 | |
| 121 std::string GetOriginalSQLStatement(); | |
| 122 | |
| 123 | |
| 124 // Binding ------------------------------------------------------------------- | |
| 125 | |
| 126 // These all take a 0-based argument index | |
| 127 void BindNull(int col); | |
| 128 void BindBool(int col, bool val); | |
| 129 void BindInt(int col, int val); | |
| 130 void BindInt64(int col, int64_t val); | |
| 131 void BindDouble(int col, double val); | |
| 132 void BindCString(int col, const char* val); | |
| 133 void BindString(int col, const std::string& val); | |
| 134 //void BindString16(int col, const string16& value); | |
| 135 void BindBlob(int col, const void* value, int value_len); | |
| 136 | |
| 137 | |
| 138 // Retrieving ---------------------------------------------------------------- | |
| 139 | |
| 140 // Returns the number of output columns in the result. | |
| 141 int ColumnCount() const; | |
| 142 | |
| 143 // Returns the type associated with the given column. | |
| 144 // | |
| 145 // Watch out: the type may be undefined if you've done something to cause a | |
| 146 // "type conversion." This means requesting the value of a column of a type | |
| 147 // where that type is not the native type. For safety, call ColumnType only | |
| 148 // on a column before getting the value out in any way. | |
| 149 ColumnType GetColumnType(int col) const; | |
| 150 ColumnType GetDeclaredColumnType(int col) const; | |
| 151 | |
| 152 // These all take a 0-based argument index. | |
| 80 | 153 bool ColumnIsNull(int col) const ; |
| 0 | 154 bool ColumnBool(int col) const; |
| 155 int ColumnInt(int col) const; | |
| 156 int64_t ColumnInt64(int col) const; | |
| 157 double ColumnDouble(int col) const; | |
| 158 std::string ColumnString(int col) const; | |
| 159 //string16 ColumnString16(int col) const; | |
| 160 | |
| 161 // When reading a blob, you can get a raw pointer to the underlying data, | |
| 162 // along with the length, or you can just ask us to copy the blob into a | |
| 163 // vector. Danger! ColumnBlob may return NULL if there is no data! | |
| 164 int ColumnByteLength(int col) const; | |
| 165 const void* ColumnBlob(int col) const; | |
| 166 bool ColumnBlobAsString(int col, std::string* blob); | |
| 167 //bool ColumnBlobAsString16(int col, string16* val) const; | |
| 724 | 168 //bool ColumnBlobAsVector(int col, std::vector<char>* val) const; |
| 169 //bool ColumnBlobAsVector(int col, std::vector<unsigned char>* val) const; | |
| 0 | 170 |
| 724 | 171 // Resets the statement to its initial condition. This includes any current |
| 172 // result row, and also the bound variables if the |clear_bound_vars| is true. | |
| 173 void Reset(bool clear_bound_vars = true); | |
| 0 | 174 }; |
| 175 } | |
| 176 } |