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