/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
 
 * database.h
 
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/>.
21
21
 */
22
22
 
23
 
#ifndef SQLITE3CC_DATABASE_H_
24
 
#define SQLITE3CC_DATABASE_H_
 
23
#ifndef SQLITE3CC_CONNECTION_H_
 
24
#define SQLITE3CC_CONNECTION_H_
25
25
 
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
 
33
34
{
34
35
 
35
36
 
36
 
class basic_statement;
37
 
class basic_transaction;
38
 
 
39
 
 
40
 
class database
 
37
namespace detail {
 
38
        class basic_statement;
 
39
        class basic_transaction;
 
40
}
 
41
class command;
 
42
class query;
 
43
 
 
44
 
 
45
class connection
41
46
        :
42
47
        private boost::noncopyable
43
48
{
44
49
//______________________________________________________________________________
 
50
//                                                                         types
 
51
public:
 
52
 
 
53
        /**
 
54
         * Class to provide a scope lock for the connection mutex
 
55
         */
 
56
        class mutex_guard
 
57
        {
 
58
        public:
 
59
 
 
60
                /**
 
61
                 * Constructor that provides a connection upon which to act.
 
62
                 *
 
63
                 * @param connection reference to a connection
 
64
                 * @see sqlite3_db_mutex()
 
65
                 * @see sqlite3_mutex_enter()
 
66
                 */
 
67
                mutex_guard(
 
68
                        connection &connection );
 
69
 
 
70
                ~mutex_guard();
 
71
 
 
72
                /**
 
73
                 * Release the mutex early.
 
74
                 *
 
75
                 * @see sqlite3_mutex_leave()
 
76
                 */
 
77
                void leave();
 
78
 
 
79
        private:
 
80
                sqlite3_mutex *_mutex;
 
81
        };
 
82
 
 
83
//______________________________________________________________________________
45
84
//                                                                 instantiation
46
85
public:
47
86
 
48
87
        /**
49
88
         * Constructor that specifies the filename of a database to open.
 
89
         *
50
90
         * @param filename the filename of the database file to open
51
91
         * @throws database_error on error
52
92
         */
53
 
        explicit database(
 
93
        explicit connection(
54
94
                const std::string &filename );
55
95
 
56
 
        explicit database();
57
 
        virtual ~database();
 
96
        explicit connection();
 
97
        virtual ~connection();
58
98
 
59
99
//______________________________________________________________________________
60
100
//                                                              public interface
62
102
 
63
103
        /**
64
104
         * Open a database.
 
105
         *
65
106
         * @param filename the filename of the database file to open
66
107
         * @param flags flags appropriate for sqlite3_open_v2()
67
108
         * @returns an sqlite error code
73
114
 
74
115
        /**
75
116
         * Close an open database.
 
117
         *
76
118
         * @throws database_error on error
77
119
         * @see sqlite3_close()
78
120
         */
79
121
        void close();
80
122
 
81
123
        /**
82
 
         * Execute an SQL statement. An exception is thrown on error.
 
124
         * Execute an SQL statement.  An exception is thrown on error.
 
125
         *
83
126
         * @param sql an SQL statement in UTF-8
84
127
         * @see sqlite3_exc()
85
128
         */
87
130
                const std::string &sql );
88
131
 
89
132
        /**
90
 
         * Sets a default busy handler which will
91
 
         * wait for the specified number of milliseconds.
92
 
         * @param milliseconds number of milliseconds to wait
 
133
         * Sets a default busy handler which will wait for the specified number of
 
134
         * milliseconds.
 
135
         *
 
136
         * @param duration number of milliseconds to wait
93
137
         * @returns an sqlite error code
94
138
         * @see sqlite3_busy_timeout()
95
139
         */
96
140
        int busy_timeout(
97
141
                int duration );
98
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
 
99
159
//______________________________________________________________________________
100
160
//                                                                implementation
101
 
protected:
 
161
private:
102
162
 
103
 
        friend class basic_statement;
104
 
        friend class basic_transaction;
 
163
        friend class detail::basic_statement;
 
164
        friend class detail::basic_transaction;
105
165
        friend class command;
106
 
        friend class query;
107
166
        friend class sqlite_error;
108
167
 
109
 
        /** class to provide a scope lock for the database mutex */
110
 
        class database_mutex_guard
111
 
        {
112
 
        public:
113
 
 
114
 
                /** constructor that provides a database */
115
 
                database_mutex_guard(
116
 
                        database &database );
117
 
 
118
 
                ~database_mutex_guard();
119
 
 
120
 
                /** release the mutex early */
121
 
                void leave();
122
 
 
123
 
        private:
124
 
                sqlite3_mutex *_mutex;
125
 
        };
126
 
 
127
 
private:
128
 
 
129
 
        /** the database handle */
 
168
        /** the connection handle */
130
169
        sqlite3 *_handle;
131
170
 
132
171
};
135
174
} // namespace sqlite
136
175
 
137
176
 
138
 
#endif /* SQLITE3CC_DATABASE_H_ */
 
177
#endif /* SQLITE3CC_CONNECTION_H_ */