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

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