/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: 2014-01-03 12:17:37 UTC
  • Revision ID: tim@ed.am-20140103121737-yq7j381e00olvw2v
removed stuff from version control that shouldn't be

Show diffs side-by-side

added added

removed removed

Lines of Context:
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/>.
35
35
 
36
36
class query
37
37
        :
38
 
        public basic_statement
 
38
        public detail::basic_statement
39
39
{
40
40
//______________________________________________________________________________
41
41
//                                                                 instantiation
42
42
public:
43
43
 
44
44
        /**
45
 
         * Constructor that provides a database upon which to act and the SQL
 
45
         * Constructor that provides a connection upon which to act and the SQL
46
46
         * query to execute.
47
 
         * @param database a reference to a database
 
47
         *
 
48
         * @param connection a reference to a connection
48
49
         * @param sql an SQL statement in UTF-8
49
50
         */
50
51
        explicit query(
51
 
                database &database,
 
52
                connection &connection,
52
53
                const std::string &sql );
53
54
 
54
55
        /**
55
 
         * Constructor that provides a database upon which to act.
56
 
         * @param database a reference to a database
57
 
         * @param sql an SQL statement in UTF-8
 
56
         * Constructor that provides a connection upon which to act.
 
57
         *
 
58
         * @param connection a reference to a connection
58
59
         */
59
60
        explicit query(
60
 
                database &database );
 
61
                connection &connection );
61
62
 
62
63
//______________________________________________________________________________
63
64
//                                                              public interface
65
66
 
66
67
        /**
67
68
         * Prepare an SQL statement.
 
69
         *
68
70
         * @param sql an SQL statement in UTF-8
69
71
         * @returns an sqlite error code
70
72
         * @see sqlite3_prepare_v2()
73
75
                const std::string &sql );
74
76
 
75
77
        /**
76
 
         * Peform a step() and return row object that can be used to retrieve the
 
78
         * Reset the statement, ready to re-execute it.  This does not clear any of
 
79
         * the values bound to the statement.
 
80
         *
 
81
         * @returns an sqlite error code
 
82
         * @see sqlite3_reset()
 
83
         */
 
84
        virtual int reset();
 
85
 
 
86
        /**
 
87
         * Perform a step() and return row object that can be used to retrieve the
77
88
         * results.
 
89
         *
78
90
         * @return a row object
79
91
         */
80
92
        row step();
81
93
 
82
94
        /**
83
 
         * Get the number of columns in the results
 
95
         * Get the number of columns in the results.
 
96
         *
84
97
         * @see sqlite3_column_count()
85
98
         */
86
99
        unsigned int column_count();
87
100
 
88
101
        /**
89
 
         * Get the name of a column in the results
 
102
         * Get the name of a column in the results.
 
103
         *
90
104
         * @param index column index
91
105
         * @see sqlite3_column_name()
92
106
         */
94
108
                unsigned int index );
95
109
 
96
110
        /**
97
 
         * Query iterator which can be used to obtain rows
 
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.
 
118
         *
 
119
         * @returns the number of results
 
120
         */
 
121
        unsigned long long num_results();
 
122
 
 
123
        /**
 
124
         * Query iterator which can be used to obtain rows.
98
125
         */
99
126
        class iterator
100
127
                :
102
129
                        boost::single_pass_traversal_tag, row >
103
130
        {
104
131
        public:
105
 
                iterator();
106
 
                explicit iterator( query &query, bool valid );
 
132
                explicit iterator( query &query, bool step );
107
133
 
108
134
        private:
109
135
                friend class boost::iterator_core_access;
112
138
                void increment();
113
139
                bool equal( iterator const &other ) const;
114
140
 
115
 
                /** is this iterator still pointing to a valid row? */
116
 
                bool _valid;
 
141
                /** the current row */
 
142
                row _row;
117
143
 
118
144
                /** the query */
119
145
                query &_query;
120
146
        };
121
147
 
122
148
        /**
123
 
         * Return an iterator to the initial row. Note that creating an iterator
 
149
         * Get an iterator to the initial row.  Note that creating an iterator
124
150
         * causes step() to be called, so it should only be called to begin
125
151
         * iterating over the rows and not for comparison.
 
152
         *
126
153
         * @return a query iterator
127
154
         */
128
155
        iterator begin();
129
156
 
130
157
        /**
131
 
         * Return an iterator to after the last row (i.e., an invalid row).
 
158
         * Get an iterator to after the last row (i.e., an invalid row).
 
159
         *
 
160
         * @return an invalid query iterator
132
161
         */
133
162
        iterator end();
134
163
 
136
165
//                                                                implementation
137
166
private:
138
167
 
139
 
        /** next row index */
140
 
        unsigned long long _next_row;
 
168
        /** next row number */
 
169
        unsigned long long _next_row_number;
141
170
 
142
171
};
143
172