/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: 2012-01-23 14:27:08 UTC
  • Revision ID: edam@waxworlds.org-20120123142708-w12277ptwtlspa6f
updated email and web addresses

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/>.
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.
48
48
        /**
49
49
         * Constructor that provides a connection upon which to act and the SQL
50
50
         * command to execute.
 
51
         *
51
52
         * @param connection a reference to a connection
52
53
         * @param sql an SQL statement in UTF-8
53
54
         */
57
58
 
58
59
        /**
59
60
         * Constructor that provides a connection upon which to act.
 
61
         *
60
62
         * @param connection a reference to a connection
61
63
         */
62
64
        explicit command(
68
70
 
69
71
        /**
70
72
         * Prepare an SQL statement.
 
73
         *
71
74
         * @param sql an SQL statement in UTF-8
72
75
         * @returns an sqlite error code
73
76
         * @see sqlite3_prepare_v2()
76
79
                const std::string &sql );
77
80
 
78
81
        /**
79
 
         * Step through one execution cycle of the SQL statement. If this is an SQL
 
82
         * Step through one execution cycle of the SQL statement.  If this is an SQL
80
83
         * statement that doesn't return any rows, only one cycle is required,
81
84
         * otherwise, each cycle will return another row
 
85
         *
82
86
         * @return an sqlite error code
83
87
         * @see sqlite3_step()
84
88
         */
85
89
        int step();
86
90
 
87
91
        /**
88
 
         * Execute the command. This is the same as doing a step().
 
92
         * Execute the command.  This is the same as doing a step().
 
93
         *
89
94
         * @return an sqlite error code
90
95
         * @see sqlite3_step()
91
96
         */
96
101
 
97
102
        /**
98
103
         * Get the number of changes made by the last successful execution of this
99
 
         * command. This doesn't include changes made in trigger subcontexts.
 
104
         * command.  This doesn't include changes made in trigger subcontexts.
 
105
         *
100
106
         * @return the number of changed rows
101
107
         * @see sqlite3_changes()
102
108
         */
107
113
 
108
114
        /**
109
115
         * Get the number of changes made by the last successful execution of this
110
 
         * command. This includes changes made in all trigger subcontexts.
 
116
         * command.  This includes changes made in all trigger subcontexts.
 
117
         *
111
118
         * @return the number of changed rows
112
119
         * @see sqlite3_total_changes()
113
120
         */
119
126
        /**
120
127
         * Get the rowid of the last row inserted via a successful INSERT command
121
128
         * (regardless of whether that is this command or not).
 
129
         *
122
130
         * @return the last inserted rowid
123
131
         */
124
132
        inline long long last_insert_rowid()