4
* Copyright (C) 2009 Tim Marston <edam@waxworlds.org>
4
* Copyright (C) 2009 Tim Marston <tim@ed.am>
6
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.
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
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/>.
45
47
* A result row from a query.
47
49
* 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
50
* query object, or until the parent query object is destructed. This may
51
* change in future versions.
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
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
69
unsigned long long row_number );
72
* Constructor that produces an invalid row.
66
76
//______________________________________________________________________________
67
77
// public interface
71
* Determine if this row is valid or not. If it is not valid, there are no
81
* Determine if this row is valid or not. If it is not valid, there are no
72
82
* more rows in the results of the query.
74
inline operator bool()
84
operator bool() const;
87
* Get the index in to the results that is this row.
91
inline unsigned long long row_number()
80
97
* Ascertain a column's type.
81
99
* @param index column index
82
100
* @return sqlite datatype code
83
101
* @see sqlite3_column_type()
86
104
unsigned int index );
89
* get the number of bytes in the result for a given column.
107
* Get the number of bytes in the result for a given column.
90
109
* @param index column index
91
110
* @return number of bytes in result
92
111
* @see sqlite3_column_bytes()
95
114
unsigned int index );
98
* Get a value from the row
117
* Get a value from the row.
99
119
* @param index column index
100
120
* @param value reference to object to set with the value
101
121
* @see sqlite3_column_*()
105
125
unsigned int index,
108
assert( index < _query.column_count() );
129
static_cast< unsigned int >( sqlite3_column_count( _handle ) ) );
109
130
const char *text = reinterpret_cast< const char * >(
110
sqlite3_column_text( _query._handle, index ) );
131
sqlite3_column_text( _handle, index ) );
112
133
value = boost::lexical_cast< T >( text );
139
* Get a value from the row and return it.
141
* @param index column index
143
* @see sqlite3_column_*()
150
column( index, value );
118
155
* 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-
156
* each column in turn. In addition, the null and set_index() auto-column-
120
157
* getting manipulators can be used.
121
159
* @param value is a variable to store the retrieved data in
123
161
template< class T >
133
171
* Stream operator for use with set_index().
135
173
row &operator >>(
174
detail::set_index_t t );
139
* Check of this row is valid
140
* @return true if it is
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
142
operator bool() const
147
186
//______________________________________________________________________________
148
187
// implementation
153
/** the parent query */
190
/** the query's handle, or NULL */
191
sqlite3_stmt *_handle;
158
195
/** index used when auto-column-getting */
159
196
unsigned int _column_index;
161
/** is this row valid? */
198
/** the index of this row */
199
unsigned long long _row_number;
167
204
// template specialisations
169
row &row::operator >> < _null_t >(
206
row &row::operator >> < detail::null_t >(
210
} // namespace sqlite
176
213
#endif /* SQLITE3CC_ROW_H_ */
added
removed
include/sqlite3cc/row.h
