/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: edam
  • Date: 2010-07-29 20:56:19 UTC
  • Revision ID: edam@waxworlds.org-20100729205619-a9yo4uzu647nvnsj
- renamed database to connection to better identify what it is (would database_connection be better though?)
- moved basic_statement and basic_transaction to sqlite::detail
- made sqlite::threadsafe() return the threading mode int, not a bool
- renamed row::index() to row_number() so it isn't confused with column index
- added typedef for deferred_transaction
- added early rollback method to transaction_guard
- allowed transaction_guard::~transaction_guard() to throw exceptions, since when it needs to, we're really screwed anyway
- bugfix: query::reset() didn't reset the internal row counter
- added query::num_results()
- added docs/design-notes
- reimplemented query::iterator so that increment() (which performs a step() on the query) now caches the returned row to be returned during dereference() (previously it stashed details and returned new row!?)
- bugfix: resetting active queries during rollbacks would hang!

Show diffs side-by-side

added added

removed removed

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