/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

include/sqlitepp/statement.hpp
1
1
/*
2
 
 * basic_statement.h
 
2
 * statement.hpp
3
3
 *
4
4
 * Copyright (C) 2009 Tim Marston <edam@waxworlds.org>
5
5
 *
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.
 
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
8
 *
9
9
 * This program is free software: you can redistribute it and/or modify
10
10
 * it under the terms of the GNU Lesser General Public License as published
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
35
35
 
36
36
 
37
37
class database;
38
 
class row;
39
 
struct _null_t;
40
 
struct _exec_t;
41
 
struct _set_index_t;
42
 
 
43
 
 
44
 
/**
45
 
 * The statement class represents an SQL statement. It is the base class for
46
 
 * both the command and the query classes, which should be used for those
47
 
 * purposes. The basic_statement class its self has protected instantiation.
48
 
 */
49
 
class basic_statement
 
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
50
73
        :
51
74
        private boost::noncopyable
52
75
{
57
80
        /**
58
81
         * Constructor that provides a database upon which to act and the SQL
59
82
         * statement.
60
 
         * @param database a reference to a database
 
83
         * @param database a reference to the database
61
84
         * @param sql an SQL statement in UTF-8
62
85
         */
63
 
        explicit basic_statement(
 
86
        statement(
64
87
                database &database,
65
88
                const std::string &sql );
66
89
 
67
 
        /**
68
 
         * Constructor that provides a database upon which to act.
69
 
         * @param database a reference to a database
70
 
         * @param sql an SQL statement in UTF-8
71
 
         */
72
 
        explicit basic_statement(
73
 
                database &database );
74
 
 
75
 
        virtual ~basic_statement();
 
90
        virtual ~statement() throw( );
76
91
 
77
92
//______________________________________________________________________________
78
93
//                                                              public interface
84
99
         * @returns an sqlite error code
85
100
         * @see sqlite3_prepare_v2()
86
101
         */
87
 
        virtual int prepare(
 
102
        int prepare(
88
103
                const std::string &sql );
89
104
 
90
105
        /**
 
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
        /**
91
115
         * Reset the statement, ready to re-execute it. This does not clear any of
92
116
         * the values bound to the statement.
93
117
         * @returns an sqlite error code
189
213
                const std::string &name,
190
214
                T value )
191
215
        {
192
 
                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 );
193
219
        }
194
220
 
195
221
        /**
243
269
 
244
270
        /**
245
271
         * Stream operator is used to bind values to parameters automatically, in
246
 
         * ascending order. In addition, the null, set_index() and execute auto-
 
272
         * ascending order. In addition, the null, execute and set_index() auto-
247
273
         * binding manipulators can be used.
248
274
         * @param value a value to bind
249
275
         */
250
276
        template< class T >
251
 
        basic_statement &operator <<(
252
 
                const T &value )
 
277
        statement &operator <<( T value )
253
278
        {
254
279
                int error_code = bind( _bind_index, value );
255
280
                if( error_code != SQLITE_OK ) throw sqlite_error( error_code );
261
286
//                                                                implementation
262
287
protected:
263
288
 
264
 
        friend class row;
265
 
 
266
289
        /**
267
290
         * Finalise an SQL statement.
268
291
         * @returns an sqlite error code
270
293
         */
271
294
        int finalize();
272
295
 
273
 
        /**
274
 
         * Step through one execution cycle of the SQL statement. If this is an SQL
275
 
         * statement that doesn't return any rows, only one cycle is required,
276
 
         * otherwise, each cycle will return another row
277
 
         * @return an sqlite error code
278
 
         * @see sqlite3_step()
279
 
         */
280
 
        int step();
281
 
 
282
 
        /**
283
 
         * Get the index number of a named parameter
284
 
         * @param parameter name
285
 
         * @return index of named parameter
286
 
         */
287
 
        int bind_parameter_index(
288
 
                const std::string &name );
 
296
private:
289
297
 
290
298
        /** the database upon which to act */
291
299
        database &_database;
293
301
        /** the statement handle */
294
302
        sqlite3_stmt *_handle;
295
303
 
296
 
private:
297
 
 
298
304
        /** index used when auto-binding */
299
305
        unsigned int _bind_index;
300
306
 
303
309
 
304
310
// template specialisations for statement::operator <<()
305
311
template< >
306
 
basic_statement &basic_statement::operator << < _null_t >(
307
 
        const _null_t & );
308
 
template< >
309
 
basic_statement &basic_statement::operator << < _exec_t >(
310
 
        const _exec_t & );
311
 
template< >
312
 
basic_statement &basic_statement::operator << < _set_index_t >(
313
 
        const _set_index_t &t );
314
 
 
315
 
 
316
 
} // namespace sqlite
317
 
 
318
 
 
319
 
#endif /* SQLITE3CC_BASIC_STATEMENT_H_ */
 
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_ */