/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:27:08 UTC
  • Revision ID: edam@waxworlds.org-20120123142708-w12277ptwtlspa6f
updated email and web addresses

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/>.
55
55
        public:
56
56
 
57
57
                /**
58
 
                 * Constructor that provides a connection upon which to act
 
58
                 * Constructor that provides a connection upon which to act.
 
59
                 *
59
60
                 * @param connection reference to a connection
60
61
                 * @see sqlite3_db_mutex()
61
62
                 * @see sqlite3_mutex_enter()
66
67
                ~mutex_guard();
67
68
 
68
69
                /**
69
 
                 * Release the mutex early
 
70
                 * Release the mutex early.
 
71
                 *
70
72
                 * @see sqlite3_mutex_leave()
71
73
                 */
72
74
                void leave();
81
83
 
82
84
        /**
83
85
         * Constructor that specifies the filename of a database to open.
 
86
         *
84
87
         * @param filename the filename of the database file to open
85
88
         * @throws database_error on error
86
89
         */
96
99
 
97
100
        /**
98
101
         * Open a database.
 
102
         *
99
103
         * @param filename the filename of the database file to open
100
104
         * @param flags flags appropriate for sqlite3_open_v2()
101
105
         * @returns an sqlite error code
107
111
 
108
112
        /**
109
113
         * Close an open database.
 
114
         *
110
115
         * @throws database_error on error
111
116
         * @see sqlite3_close()
112
117
         */
113
118
        void close();
114
119
 
115
120
        /**
116
 
         * Execute an SQL statement. An exception is thrown on error.
 
121
         * Execute an SQL statement.  An exception is thrown on error.
 
122
         *
117
123
         * @param sql an SQL statement in UTF-8
118
124
         * @see sqlite3_exc()
119
125
         */
121
127
                const std::string &sql );
122
128
 
123
129
        /**
124
 
         * Sets a default busy handler which will
125
 
         * wait for the specified number of milliseconds.
 
130
         * Sets a default busy handler which will wait for the specified number of
 
131
         * milliseconds.
 
132
         *
126
133
         * @param duration number of milliseconds to wait
127
134
         * @returns an sqlite error code
128
135
         * @see sqlite3_busy_timeout()