/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-02-08 22:08:57 UTC
  • Revision ID: edam@waxworlds.org-20100208220857-5up6fi4y6jh5bz4k
- removed "OK" from test-main when test is successful
- aranged for test/test-main to buld properly and be called from "make check"
- added include/Makefile.am to arrange for installation of library headers
- added project website to configure.ac
- added library interface configuration variable to configure.ac

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