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 handle of the statement (query) that created this row
64
* @oaram row_number the index of this row
68
unsigned long long row_number );
71
* Constructor that produces an invalid row.
75
//______________________________________________________________________________
80
* Determine if this row is valid or not. If it is not valid, there are no
81
* more rows in the results of the query.
83
operator bool() const;
86
* get the index in to the results that is this row
89
inline unsigned long long row_number()
95
* Ascertain a column's type.
96
* @param index column index
97
* @return sqlite datatype code
98
* @see sqlite3_column_type()
101
unsigned int index );
104
* get the number of bytes in the result for a given column.
105
* @param index column index
106
* @return number of bytes in result
107
* @see sqlite3_column_bytes()
109
unsigned int column_bytes(
110
unsigned int index );
113
* Get a value from the row.
114
* @param index column index
115
* @param value reference to object to set with the value
116
* @see sqlite3_column_*()
124
static_cast< unsigned int >( sqlite3_column_count( _handle ) ) );
125
const char *text = reinterpret_cast< const char * >(
126
sqlite3_column_text( _handle, index ) );
128
value = boost::lexical_cast< T >( text );
130
value = boost::get( boost::value_initialized< T >() );
134
* Get a value from the row and return it.
135
* @param index column index
137
* @see sqlite3_column_*()
144
column( index, value );
149
* Stream operator is used to obtain values from a result row, fetching from
150
* each column in turn. In addition, the null and set_index() auto-column-
151
* getting manipulators can be used.
152
* @param value is a variable to store the retrieved data in
158
column( _column_index, value );
164
* Stream operator for use with set_index().
167
detail::set_index_t t );
170
* Test to see if two rows are the same
171
* @param other the row to compare this one to
172
* @return true if they are
178
//______________________________________________________________________________
182
/** the query's handle, or NULL */
183
sqlite3_stmt *_handle;
187
/** index used when auto-column-getting */
188
unsigned int _column_index;
190
/** the index of this row */
191
unsigned long long _row_number;
196
// template specialisations
198
row &row::operator >> < detail::null_t >(
202
} // namespace sqlite
205
#endif /* SQLITE3CC_ROW_H_ */
added
removed
include/sqlite3cc/row.h
