/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 13:47:08 UTC
  • Revision ID: edam@waxworlds.org-20120123134708-ol4tilkotsm3han0
updated build system

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