4
* Copyright (C) 2009 Tim Marston <edam@waxworlds.org>
6
* This file is part of sqlite3cc (hereafter referred to as "this program").
7
* See http://www.waxworlds.org/edam/software/sqlite3cc for more information.
9
* This program is free software: you can redistribute it and/or modify
10
* it under the terms of the GNU Lesser General Public License as published
11
* by the Free Software Foundation, either version 3 of the License, or
12
* (at your option) any later version.
14
* This program is distributed in the hope that it will be useful,
15
* but WITHOUT ANY WARRANTY; without even the implied warranty of
16
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17
* GNU Lesser General Public License for more details.
19
* You should have received a copy of the GNU Lesser General Public License
20
* along with this program. If not, see <http://www.gnu.org/licenses/>.
23
#ifndef SQLITE3CC_ROW_H_
24
#define SQLITE3CC_ROW_H_
28
#include <boost/utility.hpp>
29
#include <boost/lexical_cast.hpp>
30
#include <boost/utility/value_init.hpp>
47
* A result row from a query.
49
* The row is only valid until the next call to step() or reset() on the parent
50
* query object, or until the parent query object is destructed. This may change
55
//______________________________________________________________________________
62
* Constructor that produces a valid row.
63
* @param the handle of the statement (query) that created this row
64
* @oaram the result index that is this row
68
unsigned long long index );
71
* Constructor that produces an invalid row.
72
* @param the handle of the statement (query) that created this row
76
//______________________________________________________________________________
81
* Determine if this row is valid or not. If it is not valid, there are no
82
* more rows in the results of the query.
84
inline operator bool() const
86
return _index != std::numeric_limits< unsigned long long >::max();
90
* get the index in to the results that is this row
93
inline unsigned long long index()
99
* Ascertain a column's type.
100
* @param index column index
101
* @return sqlite datatype code
102
* @see sqlite3_column_type()
105
unsigned int index );
108
* get the number of bytes in the result for a given column.
109
* @param index column index
110
* @return number of bytes in result
111
* @see sqlite3_column_bytes()
113
unsigned int column_bytes(
114
unsigned int index );
117
* Get a value from the row.
118
* @param index column index
119
* @param value reference to object to set with the value
120
* @see sqlite3_column_*()
128
static_cast< unsigned int >( sqlite3_column_count( _handle ) ) );
129
const char *text = reinterpret_cast< const char * >(
130
sqlite3_column_text( _handle, index ) );
132
value = boost::lexical_cast< T >( text );
134
value = boost::get( boost::value_initialized< T >() );
138
* Get a value from the row and return it.
139
* @param index column index
141
* @see sqlite3_column_*()
148
column( index, value );
153
* Stream operator is used to obtain values from a result row, fetching from
154
* each column in turn. In addition, the null and set_index() auto-column-
155
* getting manipulators can be used.
156
* @param value is a variable to store the retrieved data in
162
column( _column_index, value );
168
* Stream operator for use with set_index().
171
detail::set_index_t t );
173
//______________________________________________________________________________
177
/** the query's handle */
178
sqlite3_stmt *_handle;
182
/** index used when auto-column-getting */
183
unsigned int _column_index;
185
/** the index of this row */
186
unsigned long long _index;
191
// template specialisations
193
row &row::operator >> < detail::null_t >(
197
} // namespace sqlite
200
#endif /* SQLITE3CC_ROW_H_ */
added
removed
include/sqlite3cc/row.h
