/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: Tim Marston
  • Date: 2015-02-26 08:59:36 UTC
  • Revision ID: tim@ed.am-20150226085936-xe43in8bfz6f6nxb
fixed some missing/incorrect includes

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