/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/command.h

  • Committer: edam
  • Date: 2010-07-23 12:57:07 UTC
  • Revision ID: edam@waxworlds.org-20100723125707-qu9jk9vvg2uewx7t
- cleaned up test-main
- fixed comment type
- made sqlite::exec() throw instead of returning sqlite error code

Show diffs side-by-side

added added

removed removed

include/sqlite3cc/command.h
1
1
/*
2
2
 * command.h
3
3
 *
4
 
 * Copyright (C) 2009 Tim Marston <tim@ed.am>
 
4
 * Copyright (C) 2009 Tim Marston <edam@waxworlds.org>
5
5
 *
6
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.
 
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.
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/>.
25
25
 
26
26
 
27
27
#include <sqlite3cc/basic_statement.h>
28
 
#include <string>
 
28
#include <boost/thread/recursive_mutex.hpp>
29
29
 
30
30
 
31
31
namespace sqlite
33
33
 
34
34
 
35
35
/**
36
 
 * The command class represents an SQL command.  Since there is very little
 
36
 * The command class represents an SQL command. Since there is very little
37
37
 * difference between a command an a statement, it is basically a shim around
38
38
 * the statement class with the addition of an exec() method to execute the
39
39
 * command.
40
40
 */
41
41
class command
42
42
        :
43
 
        public detail::basic_statement
 
43
        public basic_statement
44
44
{
45
45
//______________________________________________________________________________
46
46
//                                                                 instantiation
47
47
public:
48
48
 
49
49
        /**
50
 
         * Constructor that provides a connection upon which to act and the SQL
 
50
         * Constructor that provides a database upon which to act and the SQL
51
51
         * command to execute.
52
 
         *
53
 
         * @param connection a reference to a connection
 
52
         * @param database a reference to a database
54
53
         * @param sql an SQL statement in UTF-8
55
54
         */
56
55
        explicit command(
57
 
                connection &connection,
 
56
                database &database,
58
57
                const std::string &sql );
59
58
 
60
59
        /**
61
 
         * Constructor that provides a connection upon which to act.
62
 
         *
63
 
         * @param connection a reference to a connection
 
60
         * Constructor that provides a database upon which to act.
 
61
         * @param database a reference to a database
64
62
         */
65
63
        explicit command(
66
 
                connection &connection );
 
64
                database &database );
67
65
 
68
66
//______________________________________________________________________________
69
67
//                                                              public interface
71
69
 
72
70
        /**
73
71
         * Prepare an SQL statement.
74
 
         *
75
72
         * @param sql an SQL statement in UTF-8
76
73
         * @returns an sqlite error code
77
74
         * @see sqlite3_prepare_v2()
80
77
                const std::string &sql );
81
78
 
82
79
        /**
83
 
         * Step through one execution cycle of the SQL statement.  If this is an SQL
 
80
         * Step through one execution cycle of the SQL statement. If this is an SQL
84
81
         * statement that doesn't return any rows, only one cycle is required,
85
82
         * otherwise, each cycle will return another row
86
 
         *
87
83
         * @return an sqlite error code
88
84
         * @see sqlite3_step()
89
85
         */
90
 
        int step();
 
86
        virtual int step();
91
87
 
92
88
        /**
93
 
         * Execute the command.  This is the same as doing a step().
94
 
         *
 
89
         * Execute the command. This is the same as doing a step().
95
90
         * @return an sqlite error code
96
91
         * @see sqlite3_step()
97
92
         */
102
97
 
103
98
        /**
104
99
         * Get the number of changes made by the last successful execution of this
105
 
         * command.  This doesn't include changes made in trigger subcontexts.
106
 
         *
 
100
         * command. This doesn't include changes made in trigger subcontexts.
107
101
         * @return the number of changed rows
108
102
         * @see sqlite3_changes()
109
103
         */
114
108
 
115
109
        /**
116
110
         * Get the number of changes made by the last successful execution of this
117
 
         * command.  This includes changes made in all trigger subcontexts.
118
 
         *
 
111
         * command. This includes changes made in all trigger subcontexts.
119
112
         * @return the number of changed rows
120
113
         * @see sqlite3_total_changes()
121
114
         */
127
120
        /**
128
121
         * Get the rowid of the last row inserted via a successful INSERT command
129
122
         * (regardless of whether that is this command or not).
130
 
         *
131
123
         * @return the last inserted rowid
132
124
         */
133
125
        inline long long last_insert_rowid()
148
140
        /** the rowid of the last successful insert command */
149
141
        long long _last_insert_rowid;
150
142
 
 
143
        /** exclusive use during command mutex */
 
144
        static boost::recursive_mutex _command_mutex;
 
145
 
151
146
};
152
147
 
153
148
 
154
 
namespace detail
155
 
{
156
 
 
157
 
 
158
 
// template specialisations for detail::basic_statement::operator <<()
159
 
template< >
160
 
basic_statement &basic_statement::operator << < detail::exec_t >(
161
 
        const detail::exec_t & );
162
 
 
163
 
 
164
 
} // namespace detail
165
 
 
166
 
 
167
149
} // namespace sqlite
168
150
 
169
151