VSQLite++  0.3
result.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_RESULT_HPP_INCLUDED
33 #define GUARD_SQLITE_RESULT_HPP_INCLUDED
34 
35 #include <boost/noncopyable.hpp>
36 #include <sqlite/ext/variant.hpp>
37 
38 namespace sqlite{
39  struct query;
40  struct result_construct_params_private;
41 
46  struct result : boost::noncopyable{
47  private:
48  typedef boost::shared_ptr<result_construct_params_private> construct_params;
49  friend struct query;
51  public:
55  ~result();
56 
61  bool next_row();
62 
66  int get_row_count();
67 
71  int get_column_count();
72 
77  type get_column_type(int idx);
78 
83  std::string get_column_decltype(int idx);
84 
89  variant_t get_variant(int index);
90 
94  int get_int(int idx);
95 
100  boost::int64_t get_int64(int idx);
101 
106  std::string get_string(int idx);
107 
112  double get_double(int idx);
113 
119  size_t get_binary_size(int idx);
120 
126  void get_binary(int idx, void * buf, size_t buf_size);
127 
133  void get_binary(int idx, std::vector<unsigned char> & vec);
134 
139  std::string get_column_name(int idx);
140  private:
141  void access_check(int);
142  private:
146  };
147 
148  typedef boost::shared_ptr<result> result_type;
149 }
150 
151 #endif //GUARD_SQLITE_RESULT_HPP_INCLUDED
sqlite::result::get_column_name
std::string get_column_name(int idx)
Returns the column name at the given index.
sqlite::result::get_int64
boost::int64_t get_int64(int idx)
Returns the data at the given index as 64-Bit Integer.
sqlite::result::access_check
void access_check(int)
sqlite::result::get_double
double get_double(int idx)
Returns the data at the given index as double.
sqlite::result::get_int
int get_int(int idx)
Returns the data at the given index as 32-Bit Integer.
sqlite::result::get_variant
variant_t get_variant(int index)
Retrieves a the current typ into variant_t.
sqlite::result::get_column_type
type get_column_type(int idx)
Returns the type of the column.
sqlite::result::get_column_decltype
std::string get_column_decltype(int idx)
Returns the type of the column.
sqlite::result::get_column_count
int get_column_count()
Returns the number of columns.
sqlite::result::m_columns
int m_columns
Definition: result.hpp:144
sqlite::result::get_string
std::string get_string(int idx)
Returns the data at the given index as String.
sqlite::result::get_binary_size
size_t get_binary_size(int idx)
Returns the size of the data at the given index in bytes.
sqlite::result_type
boost::shared_ptr< result > result_type
Definition: result.hpp:148
sqlite::query
query should be used to execute SQL queries An object of this class is not copyable
Definition: query.hpp:44
sqlite::result
result can only be created by a query object. An object of this class is not copyable.
Definition: result.hpp:46
sqlite::result::next_row
bool next_row()
Increases the row index.
sqlite::result::m_params
construct_params m_params
Definition: result.hpp:143
sqlite::result::get_row_count
int get_row_count()
Returns the number of rows in the result.
sqlite::result::~result
~result()
destructor
sqlite::result::m_row_count
int m_row_count
Definition: result.hpp:145
sqlite
Definition: command.hpp:42
variant.hpp
sqlite::type
type
Definition: variant.hpp:43
sqlite::result::get_binary
void get_binary(int idx, void *buf, size_t buf_size)
Used to retrieve a binary value.
sqlite::result::result
result(construct_params)
sqlite::variant_t
boost::variant< unknown_t, int, boost::int64_t, long double, std::string, null_t, blob_ref_t > variant_t
Definition: variant.hpp:64
sqlite::result::construct_params
boost::shared_ptr< result_construct_params_private > construct_params
Definition: result.hpp:48