VSQLite++  0.3
command.hpp
Go to the documentation of this file.
1 /*##############################################################################
2  VSQLite++ - virtuosic bytes SQLite3 C++ wrapper
3 
4  Copyright (c) 2006-2014 Vinzenz Feenstra vinzenz.feenstra@gmail.com
5  All rights reserved.
6 
7  Redistribution and use in source and binary forms, with or without modification,
8  are permitted provided that the following conditions are met:
9 
10  * Redistributions of source code must retain the above copyright notice,
11  this list of conditions and the following disclaimer.
12  * Redistributions in binary form must reproduce the above copyright notice,
13  this list of conditions and the following disclaimer in the documentation
14  and/or other materials provided with the distribution.
15  * Neither the name of virtuosic bytes nor the names of its contributors may
16  be used to endorse or promote products derived from this software without
17  specific prior written permission.
18 
19  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
23  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  POSSIBILITY OF SUCH DAMAGE.
30 
31 ##############################################################################*/
32 #ifndef GUARD_SQLITE_COMMAND_HPP_INCLUDED
33 #define GUARD_SQLITE_COMMAND_HPP_INCLUDED
34 
35 #include <boost/cstdint.hpp>
36 #include <boost/noncopyable.hpp>
37 #include <sqlite/connection.hpp>
38 #include <vector>
39 
40 struct sqlite3_stmt;
41 
42 namespace sqlite{
46  struct null_type{};
47 
51  extern null_type nil;
52 
53 
57  struct command : boost::noncopyable{
66  command(connection & con, std::string const & sql);
67 
70  virtual ~command();
71 
74  void clear();
75 
80  bool emit();
81 
85  bool operator()();
86 
90  void bind(int idx);
91 
96  void bind(int idx, int v);
97 
102  void bind(int idx, boost::int64_t v);
103 
108  void bind(int idx, double v);
109 
114  void bind(int idx, std::string const & v);
115 
121  void bind(int idx, void const * buf, size_t buf_size);
122 
128  void bind(int idx, std::vector<unsigned char> const & v);
129 
138 
145 
151  command & operator % (boost::int64_t p);
152 
158  command & operator % (double p);
159 
166  command & operator % (std::string const & p);
167 
174  command & operator % (std::vector<unsigned char> const & p);
175 
176  protected:
177  void access_check();
178  bool step();
179  struct sqlite3 * get_handle();
180  private:
181  void prepare();
182  void finalize();
183  private:
185  std::string m_sql;
186  protected:
187  sqlite3_stmt * stmt;
188  private:
190  };
191 }
192 
193 #endif //GUARD_SQLITE_COMMAND_HPP_INCLUDED
194 
sqlite::command::clear
void clear()
clear is used if you'd like to reuse a command object
sqlite::command::bind
void bind(int idx, std::vector< unsigned char > const &v)
binds the binary/blob v to the given 1 based index
sqlite::command::finalize
void finalize()
sqlite::command::get_handle
struct sqlite3 * get_handle()
sqlite::nil
null_type nil
nil is used instead of NULL within the operator % syntax in this wrapper
sqlite::null_type
null_type is an empty type used to represent NULL values
Definition: command.hpp:46
sqlite::command::m_sql
std::string m_sql
Definition: command.hpp:185
sqlite::command::~command
virtual ~command()
command destructor
sqlite::command
command is the base class of all sql command classes An object of this class is not copyable
Definition: command.hpp:57
sqlite::command::bind
void bind(int idx)
binds NULL to the given 1 based index
sqlite::command::bind
void bind(int idx, void const *buf, size_t buf_size)
binds the binary/blob buf to the given 1 based index
sqlite::command::bind
void bind(int idx, std::string const &v)
binds the text/string v to the given 1 based index
sqlite::command::bind
void bind(int idx, double v)
binds the double v to the given 1 based index
sqlite::command::stmt
sqlite3_stmt * stmt
Definition: command.hpp:187
sqlite::command::m_con
connection & m_con
Definition: command.hpp:184
connection.hpp
sqlite::command::prepare
void prepare()
sqlite::connection
connection is used to open, close, attach and detach a database. Further it has to be passed to all c...
Definition: connection.hpp:45
sqlite::command::last_arg_idx
int last_arg_idx
Definition: command.hpp:189
sqlite::command::bind
void bind(int idx, boost::int64_t v)
binds the 64-Bit integer v to the given 1 based index
sqlite::command::operator()
bool operator()()
works exactly like the method command::emit
sqlite::command::emit
bool emit()
emit executes the sql command If you have used placeholders you must have replaced all placeholders
sqlite::command::step
bool step()
sqlite::command::operator%
command & operator%(null_type const &p)
replacement for void command::bind(int idx); To use this operator% you have to use the global object ...
sqlite
Definition: command.hpp:42
sqlite::command::bind
void bind(int idx, int v)
binds the 32-Bit integer v to the given 1 based index
sqlite::command::command
command(connection &con, std::string const &sql)
command constructor
sqlite::command::access_check
void access_check()