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