4
* Copyright (C) 2009 Tim Marston <tim@ed.am>
4
* Copyright (C) 2009 Tim Marston <edam@waxworlds.org>
6
6
* This file is part of sqlite3cc (hereafter referred to as "this program").
7
* See http://ed.am/dev/sqlite3cc for more information.
9
* This program is free software: you can redistribute it and/or modify it under
10
* the terms of the GNU Lesser General Public License as published by the Free
11
* Software Foundation, either version 3 of the License, or (at your option) any
14
* This program is distributed in the hope that it will be useful, but WITHOUT
15
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
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
19
* You should have received a copy of the GNU Lesser General Public License
20
20
* along with this program. If not, see <http://www.gnu.org/licenses/>.
47
45
* A result row from a query.
49
47
* 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
51
* change in future versions.
48
* query object, or until the parent query object is destructed. This may change
62
60
* Constructor that produces a valid row.
64
* @param handle of the statement (query) that created this row
65
* @oaram row_number the index of this row
61
* @param the handle of the statement (query) that created this row
62
* @oaram the result index that is this row
68
65
sqlite3_stmt *handle,
69
unsigned long long row_number );
66
unsigned long long index );
72
69
* Constructor that produces an invalid row.
70
* @param the handle of the statement (query) that created this row
81
* Determine if this row is valid or not. If it is not valid, there are no
79
* Determine if this row is valid or not. If it is not valid, there are no
82
80
* more rows in the results of the query.
84
operator bool() const;
82
inline operator bool() const
84
return _index != std::numeric_limits< unsigned long long >::max();
87
* Get the index in to the results that is this row.
88
* get the index in to the results that is this row
91
inline unsigned long long row_number()
91
inline unsigned long long index()
97
97
* Ascertain a column's type.
99
98
* @param index column index
100
99
* @return sqlite datatype code
101
100
* @see sqlite3_column_type()
104
103
unsigned int index );
107
* Get the number of bytes in the result for a given column.
106
* get the number of bytes in the result for a given column.
109
107
* @param index column index
110
108
* @return number of bytes in result
111
109
* @see sqlite3_column_bytes()
155
151
* Stream operator is used to obtain values from a result row, fetching from
156
* each column in turn. In addition, the null and set_index() auto-column-
152
* each column in turn. In addition, the null and set_index() auto-column-
157
153
* getting manipulators can be used.
159
154
* @param value is a variable to store the retrieved data in
161
156
template< class T >
171
166
* Stream operator for use with set_index().
173
168
row &operator >>(
174
detail::set_index_t t );
177
* Test to see if two rows are the same.
179
* @param other the row to compare this one to
180
* @return true if they are
186
171
//______________________________________________________________________________
187
172
// implementation
190
/** the query's handle, or NULL */
175
/** the query's handle */
191
176
sqlite3_stmt *_handle;
196
181
unsigned int _column_index;
198
183
/** the index of this row */
199
unsigned long long _row_number;
184
unsigned long long _index;
204
189
// template specialisations
206
row &row::operator >> < detail::null_t >(
191
row &row::operator >> < _null_t >(
210
195
} // namespace sqlite