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>
45
* A result row from a query.
47
* The row is only valid until the next call to step() or reset() on the parent
48
* query object, or until the parent query object is destructed. This may change
53
//______________________________________________________________________________
60
* Constructor that produces a valid row.
61
* @param the handle of the statement (query) that created this row
62
* @oaram the result index that is this row
66
unsigned long long index );
69
* Constructor that produces an invalid row.
70
* @param the handle of the statement (query) that created this row
74
//______________________________________________________________________________
79
* Determine if this row is valid or not. If it is not valid, there are no
80
* more rows in the results of the query.
82
inline operator bool() const
84
return _index != std::numeric_limits< unsigned long long >::max();
88
* get the index in to the results that is this row
91
inline unsigned long long index()
97
* Ascertain a column's type.
98
* @param index column index
99
* @return sqlite datatype code
100
* @see sqlite3_column_type()
103
unsigned int index );
106
* get the number of bytes in the result for a given column.
107
* @param index column index
108
* @return number of bytes in result
109
* @see sqlite3_column_bytes()
111
unsigned int column_bytes(
112
unsigned int index );
115
* Get a value from the row.
116
* @param index column index
117
* @param value reference to object to set with the value
118
* @see sqlite3_column_*()
126
static_cast< unsigned int >( sqlite3_column_count( _handle ) ) );
127
const char *text = reinterpret_cast< const char * >(
128
sqlite3_column_text( _handle, index ) );
130
value = boost::lexical_cast< T >( text );
132
value = boost::get( boost::value_initialized< T >() );
136
* Get a value from the row and return it.
137
* @param index column index
139
* @see sqlite3_column_*()
146
column( index, value );
151
* Stream operator is used to obtain values from a result row, fetching from
152
* each column in turn. In addition, the null and set_index() auto-column-
153
* getting manipulators can be used.
154
* @param value is a variable to store the retrieved data in
160
column( _column_index, value );
166
* Stream operator for use with set_index().
171
//______________________________________________________________________________
175
/** the query's handle */
176
sqlite3_stmt *_handle;
180
/** index used when auto-column-getting */
181
unsigned int _column_index;
183
/** the index of thi row */
184
unsigned long long _index;
189
// template specialisations
191
row &row::operator >> < _null_t >(
195
} // namespace sqlite
198
#endif /* SQLITE3CC_ROW_H_ */
added
removed
include/sqlite3cc/row.h
