/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-01-28 12:21:03 UTC
  • Revision ID: edam@waxworlds.org-20100128122103-v3gs6hro5h7ffnhb
- further initial development
- basic support for: queries, rows (query results)
- filename, comment header and project name consistency

Show diffs side-by-side

added added

removed removed

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