4
* Copyright (C) 2009 Tim Marston <edam@waxworlds.org>
6
* This file is part of sqlitepp (hereafter referred to as "this program").
7
* See http://www.waxworlds.org/edam/software/sqlitepp 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.
4
* Copyright (C) 2009 Tim Marston <tim@ed.am>
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
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/>.
27
#include <sqlitepp/statement.hpp>
23
#ifndef SQLITE3CC_QUERY_H_
24
#define SQLITE3CC_QUERY_H_
27
#include <boost/iterator/iterator_facade.hpp>
28
#include <sqlite3cc/basic_statement.h>
29
#include <sqlite3cc/row.h>
38
public detail::basic_statement
40
//______________________________________________________________________________
45
* Constructor that provides a connection upon which to act and the SQL
48
* @param connection a reference to a connection
49
* @param sql an SQL statement in UTF-8
52
connection &connection,
53
const std::string &sql );
56
* Constructor that provides a connection upon which to act.
58
* @param connection a reference to a connection
61
connection &connection );
63
//______________________________________________________________________________
68
* Prepare an SQL statement.
70
* @param sql an SQL statement in UTF-8
71
* @returns an sqlite error code
72
* @see sqlite3_prepare_v2()
75
const std::string &sql );
78
* Reset the statement, ready to re-execute it. This does not clear any of
79
* the values bound to the statement.
81
* @returns an sqlite error code
82
* @see sqlite3_reset()
87
* Perform a step() and return row object that can be used to retrieve the
90
* @return a row object
95
* Get the number of columns in the results.
97
* @see sqlite3_column_count()
99
unsigned int column_count();
102
* Get the name of a column in the results.
104
* @param index column index
105
* @see sqlite3_column_name()
107
const std::string column_name(
108
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
113
* 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
115
* 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
117
* method reset()s the query.
119
* @returns the number of results
121
unsigned long long num_results();
124
* Query iterator which can be used to obtain rows.
128
public boost::iterator_facade< iterator, row,
129
boost::single_pass_traversal_tag, row >
132
explicit iterator( query &query, bool step );
135
friend class boost::iterator_core_access;
137
row dereference() const;
139
bool equal( iterator const &other ) const;
141
/** the current row */
149
* Get an iterator to the initial row. Note that creating an iterator
150
* causes step() to be called, so it should only be called to begin
151
* iterating over the rows and not for comparison.
153
* @return a query iterator
158
* Get an iterator to after the last row (i.e., an invalid row).
160
* @return an invalid query iterator
164
//______________________________________________________________________________
168
/** next row number */
169
unsigned long long _next_row_number;
45
#endif /* QUERY_HPP_ */
174
} // namespace sqlite
177
#endif /* SQLITE3CC_QUERY_H_ */
added
removed
include/sqlite3cc/query.h
