/sqlite3cc

To get this branch, use:
bzr branch http://bzr.ed.am/sqlite3cc

« back to all changes in this revision

Viewing changes to include/sqlite3cc/query.h

  • Committer: Tim Marston
  • Date: 2015-02-26 08:59:36 UTC
  • Revision ID: tim@ed.am-20150226085936-xe43in8bfz6f6nxb
fixed some missing/incorrect includes

Show diffs side-by-side

added added

removed removed

include/sqlite3cc/query.h
1
1
/*
2
2
 * query.h
3
3
 *
4
 
 * Copyright (C) 2009 Tim Marston <edam@waxworlds.org>
 
4
 * Copyright (C) 2009 Tim Marston <tim@ed.am>
5
5
 *
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.
8
 
 *
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.
13
 
 *
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.
 
8
 *
 
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
 
12
 * later version.
 
13
 *
 
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
 
17
 * details.
18
18
 *
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
27
#include <boost/iterator/iterator_facade.hpp>
28
28
#include <sqlite3cc/basic_statement.h>
29
29
#include <sqlite3cc/row.h>
 
30
#include <string>
30
31
 
31
32
 
32
33
namespace sqlite
44
45
        /**
45
46
         * Constructor that provides a connection upon which to act and the SQL
46
47
         * query to execute.
 
48
         *
47
49
         * @param connection a reference to a connection
48
50
         * @param sql an SQL statement in UTF-8
49
51
         */
53
55
 
54
56
        /**
55
57
         * Constructor that provides a connection upon which to act.
 
58
         *
56
59
         * @param connection a reference to a connection
57
60
         */
58
61
        explicit query(
64
67
 
65
68
        /**
66
69
         * Prepare an SQL statement.
 
70
         *
67
71
         * @param sql an SQL statement in UTF-8
68
72
         * @returns an sqlite error code
69
73
         * @see sqlite3_prepare_v2()
72
76
                const std::string &sql );
73
77
 
74
78
        /**
75
 
         * Reset the statement, ready to re-execute it. This does not clear any of
 
79
         * Reset the statement, ready to re-execute it.  This does not clear any of
76
80
         * the values bound to the statement.
 
81
         *
77
82
         * @returns an sqlite error code
78
83
         * @see sqlite3_reset()
79
84
         */
82
87
        /**
83
88
         * Perform a step() and return row object that can be used to retrieve the
84
89
         * results.
 
90
         *
85
91
         * @return a row object
86
92
         */
87
93
        row step();
88
94
 
89
95
        /**
90
 
         * Get the number of columns in the results
 
96
         * Get the number of columns in the results.
 
97
         *
91
98
         * @see sqlite3_column_count()
92
99
         */
93
100
        unsigned int column_count();
94
101
 
95
102
        /**
96
 
         * Get the name of a column in the results
 
103
         * Get the name of a column in the results.
 
104
         *
97
105
         * @param index column index
98
106
         * @see sqlite3_column_name()
99
107
         */
101
109
                unsigned int index );
102
110
 
103
111
        /**
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
 
112
         * Gets the number of results.  Be aware that this merely step()s over the
 
113
         * results and counts them, which is something you could do yourself.  This
106
114
         * method is intended to be used for convenience, where you only need know
107
 
         * the number of results and not what they are. You could also execute some
 
115
         * the number of results and not what they are.  You could also execute some
108
116
         * SQL like this: "SELECT COUNT(*) ...", but this only causes SQLite to
109
 
         * internally do the same counting as this method does. Also note that this
 
117
         * internally do the same counting as this method does.  Also note that this
110
118
         * method reset()s the query.
 
119
         *
 
120
         * @returns the number of results
111
121
         */
112
122
        unsigned long long num_results();
113
123
 
114
124
        /**
115
 
         * Query iterator which can be used to obtain rows
 
125
         * Query iterator which can be used to obtain rows.
116
126
         */
117
127
        class iterator
118
128
                :
137
147
        };
138
148
 
139
149
        /**
140
 
         * Get an iterator to the initial row. Note that creating an iterator
 
150
         * Get an iterator to the initial row.  Note that creating an iterator
141
151
         * causes step() to be called, so it should only be called to begin
142
152
         * iterating over the rows and not for comparison.
 
153
         *
143
154
         * @return a query iterator
144
155
         */
145
156
        iterator begin();
146
157
 
147
158
        /**
148
159
         * Get an iterator to after the last row (i.e., an invalid row).
 
160
         *
149
161
         * @return an invalid query iterator
150
162
         */
151
163
        iterator end();