/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/connection.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/connection.h
1
1
/*
2
2
 * connection.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/>.
26
26
 
27
27
#include <sqlite3.h>
28
28
#include <boost/utility.hpp>
 
29
#include <boost/shared_ptr.hpp>
29
30
#include <string>
30
31
 
31
32
 
37
38
        class basic_statement;
38
39
        class basic_transaction;
39
40
}
 
41
class command;
 
42
class query;
40
43
 
41
44
 
42
45
class connection
55
58
        public:
56
59
 
57
60
                /**
58
 
                 * Constructor that provides a connection upon which to act
 
61
                 * Constructor that provides a connection upon which to act.
 
62
                 *
59
63
                 * @param connection reference to a connection
60
64
                 * @see sqlite3_db_mutex()
61
65
                 * @see sqlite3_mutex_enter()
66
70
                ~mutex_guard();
67
71
 
68
72
                /**
69
 
                 * Release the mutex early
 
73
                 * Release the mutex early.
 
74
                 *
70
75
                 * @see sqlite3_mutex_leave()
71
76
                 */
72
77
                void leave();
81
86
 
82
87
        /**
83
88
         * Constructor that specifies the filename of a database to open.
 
89
         *
84
90
         * @param filename the filename of the database file to open
85
91
         * @throws database_error on error
86
92
         */
96
102
 
97
103
        /**
98
104
         * Open a database.
 
105
         *
99
106
         * @param filename the filename of the database file to open
100
107
         * @param flags flags appropriate for sqlite3_open_v2()
101
108
         * @returns an sqlite error code
107
114
 
108
115
        /**
109
116
         * Close an open database.
 
117
         *
110
118
         * @throws database_error on error
111
119
         * @see sqlite3_close()
112
120
         */
113
121
        void close();
114
122
 
115
123
        /**
116
 
         * Execute an SQL statement. An exception is thrown on error.
 
124
         * Execute an SQL statement.  An exception is thrown on error.
 
125
         *
117
126
         * @param sql an SQL statement in UTF-8
118
127
         * @see sqlite3_exc()
119
128
         */
121
130
                const std::string &sql );
122
131
 
123
132
        /**
124
 
         * Sets a default busy handler which will
125
 
         * wait for the specified number of milliseconds.
 
133
         * Sets a default busy handler which will wait for the specified number of
 
134
         * milliseconds.
 
135
         *
126
136
         * @param duration number of milliseconds to wait
127
137
         * @returns an sqlite error code
128
138
         * @see sqlite3_busy_timeout()
130
140
        int busy_timeout(
131
141
                int duration );
132
142
 
 
143
        /**
 
144
         * Create a command.
 
145
         *
 
146
         * @param sql an SQL statement in UTF-8
 
147
         */
 
148
        boost::shared_ptr< command > make_command(
 
149
                std::string sql );
 
150
 
 
151
        /**
 
152
         * Create a query.
 
153
         *
 
154
         * @param sql an SQL statement in UTF-8
 
155
         */
 
156
        boost::shared_ptr< query > make_query(
 
157
                std::string sql );
 
158
 
133
159
//______________________________________________________________________________
134
160
//                                                                implementation
135
161
private: