/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

1
1
/*
2
 
 * database.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.
 
2
 * command.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.
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 COMMAND_HPP_
24
 
#define COMMAND_HPP_
25
 
 
26
 
 
27
 
#include "statement.hpp"
 
23
#ifndef SQLITE3CC_COMMAND_H_
 
24
#define SQLITE3CC_COMMAND_H_
 
25
 
 
26
 
 
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 statement
 
43
        public detail::basic_statement
43
44
{
44
45
//______________________________________________________________________________
45
46
//                                                                 instantiation
46
47
public:
47
48
 
48
49
        /**
49
 
         * Constructor that provides the SQL statement to execute
 
50
         * Constructor that provides a connection upon which to act and the SQL
 
51
         * command to execute.
 
52
         *
 
53
         * @param connection a reference to a connection
50
54
         * @param sql an SQL statement in UTF-8
51
55
         */
52
 
        command(
53
 
                database &database,
54
 
                const std::string &sql )
55
 
                :
56
 
                statement( database, sql )
57
 
        { }
 
56
        explicit command(
 
57
                connection &connection,
 
58
                const std::string &sql );
 
59
 
 
60
        /**
 
61
         * Constructor that provides a connection upon which to act.
 
62
         *
 
63
         * @param connection a reference to a connection
 
64
         */
 
65
        explicit command(
 
66
                connection &connection );
58
67
 
59
68
//______________________________________________________________________________
60
69
//                                                              public interface
61
70
public:
62
71
 
63
72
        /**
64
 
         * Execute the command. This is the same as doing a step().
 
73
         * Prepare an SQL statement.
 
74
         *
 
75
         * @param sql an SQL statement in UTF-8
 
76
         * @returns an sqlite error code
 
77
         * @see sqlite3_prepare_v2()
 
78
         */
 
79
        virtual int prepare(
 
80
                const std::string &sql );
 
81
 
 
82
        /**
 
83
         * Step through one execution cycle of the SQL statement.  If this is an SQL
 
84
         * statement that doesn't return any rows, only one cycle is required,
 
85
         * otherwise, each cycle will return another row
 
86
         *
 
87
         * @return an sqlite error code
 
88
         * @see sqlite3_step()
 
89
         */
 
90
        int step();
 
91
 
 
92
        /**
 
93
         * Execute the command.  This is the same as doing a step().
 
94
         *
 
95
         * @return an sqlite error code
65
96
         * @see sqlite3_step()
66
97
         */
67
98
        inline int exec()
69
100
                return step();
70
101
        }
71
102
 
 
103
        /**
 
104
         * 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
         *
 
107
         * @return the number of changed rows
 
108
         * @see sqlite3_changes()
 
109
         */
 
110
        inline int changes()
 
111
        {
 
112
                return _changes;
 
113
        }
 
114
 
 
115
        /**
 
116
         * Get the number of changes made by the last successful execution of this
 
117
         * command.  This includes changes made in all trigger subcontexts.
 
118
         *
 
119
         * @return the number of changed rows
 
120
         * @see sqlite3_total_changes()
 
121
         */
 
122
        inline int total_changes()
 
123
        {
 
124
                return _total_changes;
 
125
        }
 
126
 
 
127
        /**
 
128
         * Get the rowid of the last row inserted via a successful INSERT command
 
129
         * (regardless of whether that is this command or not).
 
130
         *
 
131
         * @return the last inserted rowid
 
132
         */
 
133
        inline long long last_insert_rowid()
 
134
        {
 
135
                return _last_insert_rowid;
 
136
        }
 
137
 
 
138
//______________________________________________________________________________
 
139
//                                                                implementation
 
140
private:
 
141
 
 
142
        /** non-recursive number of changes made by the last execution */
 
143
        int _changes;
 
144
 
 
145
        /** recursive number of changes made by the last execution */
 
146
        int _total_changes;
 
147
 
 
148
        /** the rowid of the last successful insert command */
 
149
        long long _last_insert_rowid;
 
150
 
72
151
};
73
152
 
74
153
 
75
 
}
76
 
 
77
 
 
78
 
#endif /* COMMAND_HPP_ */
 
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
} // namespace sqlite
 
168
 
 
169
 
 
170
#endif /* SQLITE3CC_COMMAND_H_ */