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_
27
#include <sqlite3cc/query.h>
29
#include <boost/utility.hpp>
30
#include <boost/lexical_cast.hpp>
31
#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
//______________________________________________________________________________
58
* Constructor that provides the database that we were extracted from.
59
* @param the query that this row belongs to
60
* @oaram true if this row represents there being no more rows
66
//______________________________________________________________________________
71
* Determine if this row is valid or not. If it is not valid, there are no
72
* more rows in the results of the query.
74
inline operator bool()
80
* Ascertain a column's type.
81
* @param index column index
82
* @return sqlite datatype code
83
* @see sqlite3_column_type()
89
* get the number of bytes in the result for a given column.
90
* @param index column index
91
* @return number of bytes in result
92
* @see sqlite3_column_bytes()
94
unsigned int column_bytes(
98
* Get a value from the row
99
* @param index column index
100
* @param value reference to object to set with the value
101
* @see sqlite3_column_*()
108
assert( index < _query.column_count() );
109
const char *text = reinterpret_cast< const char * >(
110
sqlite3_column_text( _query._handle, index ) );
112
value = boost::lexical_cast< T >( text );
114
value = boost::get( boost::value_initialized< T >() );
118
* Stream operator is used to obtain values from a result row, fetching from
119
* each column in turn. In addition, the null and set_index() auto-column-
120
* getting manipulators can be used.
121
* @param value is a variable to store the retrieved data in
127
column( _column_index, value );
133
* Stream operator for use with set_index().
139
* Check of this row is valid
140
* @return true if it is
142
operator bool() const
147
//______________________________________________________________________________
153
/** the parent query */
158
/** index used when auto-column-getting */
159
unsigned int _column_index;
161
/** is this row valid? */
167
// template specialisations
169
row &row::operator >> < _null_t >(
176
#endif /* SQLITE3CC_ROW_H_ */