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
* 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
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
69
unsigned long long row_number );
72
* Constructor that produces an invalid row.
76
66
//______________________________________________________________________________
77
67
// public interface
81
* Determine if this row is valid or not. If it is not valid, there are no
71
* Determine if this row is valid or not. If it is not valid, there are no
82
72
* more rows in the results of the query.
84
operator bool() const;
87
* Get the index in to the results that is this row.
91
inline unsigned long long row_number()
74
inline operator bool()
97
80
* Ascertain a column's type.
99
81
* @param index column index
100
82
* @return sqlite datatype code
101
83
* @see sqlite3_column_type()
104
86
unsigned int index );
107
* Get the number of bytes in the result for a given column.
89
* get the number of bytes in the result for a given column.
109
90
* @param index column index
110
91
* @return number of bytes in result
111
92
* @see sqlite3_column_bytes()
114
95
unsigned int index );
117
* Get a value from the row.
98
* Get a value from the row
119
99
* @param index column index
120
100
* @param value reference to object to set with the value
121
101
* @see sqlite3_column_*()
125
105
unsigned int index,
129
static_cast< unsigned int >( sqlite3_column_count( _handle ) ) );
131
switch( column_type( index ) ) {
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 );
133
114
value = boost::get( boost::value_initialized< T >() );
136
int length = sqlite3_column_bytes( _handle, index );
137
std::string string_value( static_cast< const char * >(
138
sqlite3_column_blob( _handle, index ) ), length );
139
value = boost::lexical_cast< T >( string_value );
143
const char *text = reinterpret_cast< const char * >(
144
sqlite3_column_text( _handle, index ) );
145
value = boost::lexical_cast< T >( text );
150
* Get a value from the row and return it.
152
* @param index column index
154
* @see sqlite3_column_*()
161
column( index, value );
166
118
* Stream operator is used to obtain values from a result row, fetching from
167
* each column in turn. In addition, the null and set_index() auto-column-
119
* each column in turn. In addition, the null and set_index() auto-column-
168
120
* getting manipulators can be used.
170
121
* @param value is a variable to store the retrieved data in
172
123
template< class T >
182
133
* Stream operator for use with set_index().
184
135
row &operator >>(
185
detail::set_index_t t );
188
* Test to see if two rows are the same.
190
* @param other the row to compare this one to
191
* @return true if they are
139
* Check of this row is valid
140
* @return true if it is
142
operator bool() const
197
147
//______________________________________________________________________________
198
148
// implementation
201
/** the query's handle, or NULL */
202
sqlite3_stmt *_handle;
153
/** the parent query */
206
158
/** index used when auto-column-getting */
207
159
unsigned int _column_index;
209
/** the index of this row */
210
unsigned long long _row_number;
161
/** is this row valid? */
215
167
// template specialisations
217
row &row::operator >> < detail::null_t >(
221
} // namespace sqlite
169
row &row::operator >> < _null_t >(
224
176
#endif /* SQLITE3CC_ROW_H_ */
added
removed
include/sqlite3cc/row.h
