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/>.
75
72
const std::string &sql );
78
* Reset the statement, ready to re-execute it. This does not clear any of
75
* Reset the statement, ready to re-execute it. This does not clear any of
79
76
* the values bound to the statement.
81
77
* @returns an sqlite error code
82
78
* @see sqlite3_reset()
87
83
* Perform a step() and return row object that can be used to retrieve the
90
85
* @return a row object
95
* Get the number of columns in the results.
90
* Get the number of columns in the results
97
91
* @see sqlite3_column_count()
99
93
unsigned int column_count();
102
* Get the name of a column in the results.
96
* Get the name of a column in the results
104
97
* @param index column index
105
98
* @see sqlite3_column_name()
108
101
unsigned int index );
111
* Gets the number of results. Be aware that this merely step()s over the
112
* results and counts them, which is something you could do yourself. This
104
* Gets the number of results. Be aware that this merely step()s over the
105
* results and counts them, which is something you could do yourself. This
113
106
* method is intended to be used for convenience, where you only need know
114
* the number of results and not what they are. You could also execute some
107
* the number of results and not what they are. You could also execute some
115
108
* SQL like this: "SELECT COUNT(*) ...", but this only causes SQLite to
116
* internally do the same counting as this method does. Also note that this
109
* internally do the same counting as this method does. Also note that this
117
110
* method reset()s the query.
119
* @returns the number of results
121
112
unsigned long long num_results();
124
* Query iterator which can be used to obtain rows.
115
* Query iterator which can be used to obtain rows
149
* Get an iterator to the initial row. Note that creating an iterator
140
* Get an iterator to the initial row. Note that creating an iterator
150
141
* causes step() to be called, so it should only be called to begin
151
142
* iterating over the rows and not for comparison.
153
143
* @return a query iterator
155
145
iterator begin();
158
148
* Get an iterator to after the last row (i.e., an invalid row).
160
149
* @return an invalid query iterator