/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/database.h

  • Committer: edam
  • Date: 2010-07-23 12:57:07 UTC
  • Revision ID: edam@waxworlds.org-20100723125707-qu9jk9vvg2uewx7t
- cleaned up test-main
- fixed comment type
- made sqlite::exec() throw instead of returning sqlite error code

Show diffs side-by-side

added added

removed removed

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