/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: edam
  • Date: 2012-01-23 14:34:45 UTC
  • Revision ID: edam@waxworlds.org-20120123143445-s2v4v90nycmfm6bv
fixed up tests

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