/sqlite3cc

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

« back to all changes in this revision

Viewing changes to include/sqlitepp/statement.hpp

  • Committer: edam
  • Date: 2009-11-25 20:32:34 UTC
  • Revision ID: edam@waxworlds.org-20091125203234-24i7mzd60c7o46py
- initial commit
- basic support for: database, statements, commands, transactions, exceptions
- initial test app
- initial liscence and readme

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/sqlitepp/statement.hpp
1
1
/*
2
 
 * basic_statement.h
3
 
 *
4
 
 * Copyright (C) 2009 Tim Marston <tim@ed.am>
5
 
 *
6
 
 * This file is part of sqlite3cc (hereafter referred to as "this program").
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.
 
2
 * statement.hpp
 
3
 *
 
4
 * Copyright (C) 2009 Tim Marston <edam@waxworlds.org>
 
5
 *
 
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.
 
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.
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/>.
21
21
 */
22
22
 
23
 
#ifndef SQLITE3CC_BASIC_STATEMENT_H_
24
 
#define SQLITE3CC_BASIC_STATEMENT_H_
 
23
#ifndef STATEMENT_HPP_
 
24
#define STATEMENT_HPP_
25
25
 
26
26
 
27
27
#include <sqlite3.h>
28
28
#include <boost/utility.hpp>
29
29
#include <boost/lexical_cast.hpp>
30
 
#include <sqlite3cc/exception.h>
 
30
#include <sqlitepp/exception.hpp>
31
31
 
32
32
 
33
33
namespace sqlite
34
34
{
35
35
 
36
36
 
37
 
class connection;
38
 
class row;
39
 
namespace detail {
40
 
        struct null_t;
41
 
        struct exec_t;
42
 
        struct set_index_t;
43
 
}
44
 
 
45
 
 
46
 
namespace detail
47
 
{
48
 
 
49
 
 
50
 
/**
51
 
 * The statement class represents an SQL statement.  It is the base class for
52
 
 * both the command and the query classes, which should be used for those
53
 
 * purposes.  The basic_statement class its self has protected instantiation.
54
 
 */
55
 
class basic_statement
 
37
class database;
 
38
 
 
39
 
 
40
struct _null_t { };
 
41
struct _exec_t { };
 
42
struct _set_index_t { unsigned int _index; };
 
43
 
 
44
/**
 
45
 * Auto-binding manipulator, for use with a statment's stream operator. This
 
46
 * specifies a NULL value to bind to a parameter.
 
47
 */
 
48
extern const _null_t null;
 
49
 
 
50
/**
 
51
 * Auto-binding manipulator, for use with a statment's stream operator. This
 
52
 * indicates that the statement should be executed immediately. Unlike a
 
53
 * statment's exec() method, this will throw on error. Also, it will throw if
 
54
 * the execution returns any result rows.
 
55
 */
 
56
extern const _exec_t exec;
 
57
 
 
58
/**
 
59
 * Auto-binding manipulator, for use with a statment's stream operator. This
 
60
 * manipulator sets the index used to automatically assign values to parameters.
 
61
 * @param index the new index for incremental assignment
 
62
 */
 
63
_set_index_t set_index(
 
64
        unsigned int index );
 
65
 
 
66
 
 
67
/**
 
68
 * The statement class represents an SQL statement. It is the bas class for both
 
69
 * the command and the query classes which should be used for those purposes.
 
70
 * The statement class its self has protected instantiation.
 
71
 */
 
72
class statement
56
73
        :
57
74
        private boost::noncopyable
58
75
{
61
78
protected:
62
79
 
63
80
        /**
64
 
         * Constructor that provides a connection upon which to act and the SQL
 
81
         * Constructor that provides a database upon which to act and the SQL
65
82
         * statement.
66
 
         *
67
 
         * @param connection a reference to a connection
 
83
         * @param database a reference to the database
68
84
         * @param sql an SQL statement in UTF-8
69
85
         */
70
 
        explicit basic_statement(
71
 
                connection &connection,
 
86
        statement(
 
87
                database &database,
72
88
                const std::string &sql );
73
89
 
74
 
        /**
75
 
         * Constructor that provides a connection upon which to act.
76
 
         *
77
 
         * @param connection a reference to a connection
78
 
         */
79
 
        explicit basic_statement(
80
 
                connection &connection );
81
 
 
82
 
        virtual ~basic_statement();
 
90
        virtual ~statement() throw( );
83
91
 
84
92
//______________________________________________________________________________
85
93
//                                                              public interface
87
95
 
88
96
        /**
89
97
         * Prepare an SQL statement.
90
 
         *
91
98
         * @param sql an SQL statement in UTF-8
92
99
         * @returns an sqlite error code
93
100
         * @see sqlite3_prepare_v2()
94
101
         */
95
 
        virtual int prepare(
 
102
        int prepare(
96
103
                const std::string &sql );
97
104
 
98
105
        /**
99
 
         * Reset the statement, ready to re-execute it.  This does not clear any of
 
106
         * Step through one execution cycle of the SQL statement. If this is an SQL
 
107
         * statement that doesn't return any rows, only one cycle is required,
 
108
         * otherwise, each cycle will return another row
 
109
         * @return an sqlite error code
 
110
         * @see sqlite3_step()
 
111
         */
 
112
        int step();
 
113
 
 
114
        /**
 
115
         * Reset the statement, ready to re-execute it. This does not clear any of
100
116
         * the values bound to the statement.
101
 
         *
102
117
         * @returns an sqlite error code
103
118
         * @see sqlite3_reset()
104
119
         */
105
 
        virtual int reset();
 
120
        int reset();
106
121
 
107
122
        /**
108
123
         * Clears the values bound to a statement to NULL.
109
 
         *
110
124
         * @returns an sqlite error code
111
125
         * @see sqlite3_clear_bindings()
112
126
         */
113
127
        int clear_bindings();
114
128
 
115
129
        /**
116
 
         * Bind a value to the SQL statement via it's index.  This template will
117
 
         * take a variety of data types and bind them as text.  This is how sqlite
 
130
         * Bind a value to the SQL statement via it's index. This template will take
 
131
         * a variety of data types and bind them as text. This is how sqlite
118
132
         * internally stores the data anyway, so always binding as text just means
119
133
         * we do the conversion instead of sqlite and is no less efficient.
120
 
         *
121
134
         * @param index the index of the parameter to bind to
122
135
         * @param value the value to bind
123
136
         * @returns an sqlite error code
135
148
 
136
149
        /**
137
150
         * Bind a string value to the SQL statement via it's index where the value
138
 
         * of that string will not change for the duration of the statement.  This
139
 
         * is more optimal because sqlite will not have to take it's own copy of the
 
151
         * of that string will not change for the duration of the statement. This is
 
152
         * more optimal because sqlite will not have to make it's own copy of the
140
153
         * data.
141
 
         *
142
154
         * @param index the index of the parameter to bind to
143
155
         * @param value the invariant string value
144
 
         * @param value_length the length of the string including zero-terminator
145
156
         * @returns an sqlite error code
146
157
         * @see sqlite3_bind_text()
147
158
         */
152
163
 
153
164
        /**
154
165
         * Bind a string value to the SQL statement via it's index where the value
155
 
         * of that string will not change for the duration of the statement.  This
156
 
         * is more optimal because sqlite will not have to take it's own copy of the
 
166
         * of that string will not change for the duration of the statement. This is
 
167
         * more optimal  because sqlite will not have to make it's own copy of the
157
168
         * data.
158
 
         *
159
169
         * @param index the index of the parameter to bind to
160
170
         * @param value the invariant string value
161
171
         * @returns an sqlite error code
167
177
 
168
178
        /**
169
179
         * Bind a string value to the SQL statement via it's index where the value
170
 
         * of that string will not change for the duration of the statement.  This
171
 
         * is more optimal because sqlite will not have to take it's own copy of the
 
180
         * of that string will not change for the duration of the statement. This is
 
181
         * more optimal because sqlite will not have to make it's own copy of the
172
182
         * data.
173
 
         *
174
183
         * @param index the index of the parameter to bind to
175
184
         * @param value the invariant string value
176
185
         * @returns an sqlite error code
182
191
 
183
192
        /**
184
193
         * Bind a NULL value to the SQL statement via it's index.
185
 
         *
186
194
         * @param index the index of the parameter to bind to
187
195
         * @returns an sqlite error code
188
196
         * @see sqlite3_bind_null()
191
199
                unsigned int index );
192
200
 
193
201
        /**
194
 
         * Bind a value to the SQL statement via a named parameter.  This template
195
 
         * will take a variety of data types and bind them as text.  This is how
 
202
         * Bind a value to the SQL statement via a named parameter. This template
 
203
         * will take a variety of data types and bind them as text. This is how
196
204
         * sqlite internally stores the data anyway, so always binding as text just
197
205
         * means we do the conversion instead of sqlite and is no less efficient.
198
 
         *
199
206
         * @param name the named parameter to bind to
200
207
         * @param value the value to bind
201
208
         * @returns an sqlite error code
206
213
                const std::string &name,
207
214
                T value )
208
215
        {
209
 
                return bind( bind_parameter_index( name ), value );
 
216
                unsigned int index =
 
217
                        sqlite3_bind_parameter_index( _handle, name.c_str() );
 
218
                return bind( index, value );
210
219
        }
211
220
 
212
221
        /**
213
222
         * Bind a string value to the SQL statement via a named parameter where the
214
 
         * string value will not change for the duration of the statement.  This
215
 
         * prevents sqlite from taking its own copy of the string.
216
 
         *
 
223
         * string value will not change for the duration of the statement. This
 
224
         * prevents a copy of the string being taken.
217
225
         * @param name the named parameter to bind to
218
226
         * @param value the invariant string value
219
 
         * @param value_length the length of the string including zero-terminator
220
227
         * @returns an sqlite error code
221
228
         * @see sqlite3_bind_text()
222
229
         */
227
234
 
228
235
        /**
229
236
         * Bind a string value to the SQL statement via a named parameter where the
230
 
         * string value will not change for the duration of the statement.  This
 
237
         * string value will not change for the duration of the statement. This
231
238
         * prevents a copy of the string being taken.
232
 
         *
233
239
         * @param name the named parameter to bind to
234
240
         * @param value the invariant string value
235
241
         * @returns an sqlite error code
241
247
 
242
248
        /**
243
249
         * Bind a string value to the SQL statement via a named parameter where the
244
 
         * string value will not change for the duration of the statement.  This
 
250
         * string value will not change for the duration of the statement. This
245
251
         * prevents a copy of the string being taken.
246
 
         *
247
252
         * @param name the named parameter to bind to
248
253
         * @param value the invariant string value
249
254
         * @returns an sqlite error code
255
260
 
256
261
        /**
257
262
         * Bind a NULL value to the SQL statement via a named parameter.
258
 
         *
259
263
         * @param name the named parameter to bind to
260
264
         * @returns an sqlite error code
261
265
         * @see sqlite3_bind_null()
265
269
 
266
270
        /**
267
271
         * Stream operator is used to bind values to parameters automatically, in
268
 
         * ascending order.  In addition, the null and set_index() auto-binding
269
 
         * manipulators can be used.
270
 
         *
 
272
         * ascending order. In addition, the null, execute and set_index() auto-
 
273
         * binding manipulators can be used.
271
274
         * @param value a value to bind
272
275
         */
273
276
        template< class T >
274
 
        basic_statement &operator <<(
275
 
                const T &value )
 
277
        statement &operator <<( T value )
276
278
        {
277
 
                int code = bind( _bind_index, value );
278
 
                if( code != SQLITE_OK ) throw sqlite_error( _connection, code );
 
279
                int error_code = bind( _bind_index, value );
 
280
                if( error_code != SQLITE_OK ) throw sqlite_error( error_code );
279
281
                _bind_index++;
280
282
                return *this;
281
283
        }
284
286
//                                                                implementation
285
287
protected:
286
288
 
287
 
        friend class row;
288
 
 
289
289
        /**
290
290
         * Finalise an SQL statement.
291
 
         *
292
291
         * @returns an sqlite error code
293
292
         * @see sqlite3_finalize()
294
293
         */
295
294
        int finalize();
296
295
 
297
 
        /**
298
 
         * Get the index number of a named parameter.
299
 
         *
300
 
         * @param parameter name
301
 
         * @return index of named parameter
302
 
         */
303
 
        int bind_parameter_index(
304
 
                const std::string &name );
305
 
 
306
 
        /**
307
 
         * Perform a step.
308
 
         *
309
 
         * @return sqlite error code
310
 
         * @see sqlite3_step()
311
 
         */
312
 
        int step();
313
 
 
314
 
        /** the connection upon which to act */
315
 
        connection &_connection;
 
296
private:
 
297
 
 
298
        /** the database upon which to act */
 
299
        database &_database;
316
300
 
317
301
        /** the statement handle */
318
302
        sqlite3_stmt *_handle;
323
307
};
324
308
 
325
309
 
326
 
// template specialisations for basic_statement::operator <<()
327
 
template< >
328
 
basic_statement &basic_statement::operator << < detail::null_t >(
329
 
        const detail::null_t & );
330
 
template< >
331
 
basic_statement &basic_statement::operator << < detail::set_index_t >(
332
 
        const detail::set_index_t &t );
333
 
 
334
 
 
335
 
} // namespace detail
336
 
 
337
 
 
338
 
} // namespace sqlite
339
 
 
340
 
 
341
 
#endif /* SQLITE3CC_BASIC_STATEMENT_H_ */
 
310
// template specialisations for statement::operator <<()
 
311
template< >
 
312
statement& statement::operator << < _null_t >(
 
313
        _null_t );
 
314
template< >
 
315
statement& statement::operator << < _exec_t >(
 
316
        _exec_t );
 
317
template< >
 
318
statement& statement::operator << < _set_index_t >(
 
319
        _set_index_t t );
 
320
 
 
321
 
 
322
}
 
323
 
 
324
 
 
325
#endif /* STATEMENT_HPP_ */