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

  • Committer: Tim Marston
  • Date: 2015-02-26 08:56:26 UTC
  • Revision ID: tim@ed.am-20150226085626-vba9c55uz3ta094h
improved support for blobs: added bind_blob(), added blob_t for binding stream
operators and blob() creation function; detect blob column type in row::column()

Show diffs side-by-side

added added

removed removed

include/sqlite3cc/basic_statement.h
28
28
#include <boost/utility.hpp>
29
29
#include <boost/lexical_cast.hpp>
30
30
#include <sqlite3cc/exception.h>
 
31
#include <string>
31
32
 
32
33
 
33
34
namespace sqlite
40
41
        struct null_t;
41
42
        struct exec_t;
42
43
        struct set_index_t;
 
44
        struct blob_t;
43
45
}
44
46
 
45
47
 
111
113
        int clear_bindings();
112
114
 
113
115
        /**
114
 
         * Bind a value to the SQL statement via it's index.  This template will
115
 
         * take a variety of data types and bind them as text.  This is how sqlite
116
 
         * internally stores the data anyway, so always binding as text just means
117
 
         * we do the conversion instead of sqlite and is no less efficient.
 
116
         * Bind a value to the SQL statement via it's index.
118
117
         *
119
118
         * @param index the index of the parameter to bind to
120
119
         * @param value the value to bind
124
123
        template< class T >
125
124
        int bind(
126
125
                unsigned int index,
127
 
                T value )
 
126
                const T &value )
128
127
        {
 
128
                // bind as text (applying the type affinity of the underlying column)
129
129
                std::string string_value = boost::lexical_cast< std::string >( value );
130
130
                return sqlite3_bind_text( _handle, index, string_value.c_str(),
131
131
                        string_value.length(), SQLITE_TRANSIENT );
132
132
        }
133
133
 
134
134
        /**
135
 
         * Bind a string value to the SQL statement via it's index where the value
136
 
         * of that string will not change for the duration of the statement.  This
137
 
         * is more optimal because sqlite will not have to take it's own copy of the
138
 
         * data.
139
 
         *
140
 
         * @param index the index of the parameter to bind to
141
 
         * @param value the invariant string value
142
 
         * @param value_length the length of the string including zero-terminator
143
 
         * @returns an sqlite error code
144
 
         * @see sqlite3_bind_text()
145
 
         */
146
 
        int bind_static(
147
 
                unsigned int index,
148
 
                const char *value,
149
 
                unsigned int value_length );
150
 
 
151
 
        /**
152
 
         * Bind a string value to the SQL statement via it's index where the value
153
 
         * of that string will not change for the duration of the statement.  This
154
 
         * is more optimal because sqlite will not have to take it's own copy of the
155
 
         * data.
156
 
         *
157
 
         * @param index the index of the parameter to bind to
158
 
         * @param value the invariant string value
159
 
         * @returns an sqlite error code
160
 
         * @see sqlite3_bind_text()
161
 
         */
162
 
        int bind_static(
163
 
                unsigned int index,
164
 
                const char *value );
165
 
 
166
 
        /**
167
 
         * Bind a string value to the SQL statement via it's index where the value
168
 
         * of that string will not change for the duration of the statement.  This
169
 
         * is more optimal because sqlite will not have to take it's own copy of the
170
 
         * data.
171
 
         *
172
 
         * @param index the index of the parameter to bind to
173
 
         * @param value the invariant string value
174
 
         * @returns an sqlite error code
175
 
         * @see sqlite3_bind_text()
176
 
         */
177
 
        int bind_static(
178
 
                unsigned int index,
179
 
                const std::string &value );
180
 
 
181
 
        /**
182
 
         * Bind a NULL value to the SQL statement via it's index.
183
 
         *
184
 
         * @param index the index of the parameter to bind to
185
 
         * @returns an sqlite error code
186
 
         * @see sqlite3_bind_null()
187
 
         */
188
 
        int bind_null(
189
 
                unsigned int index );
190
 
 
191
 
        /**
192
 
         * Bind a value to the SQL statement via a named parameter.  This template
193
 
         * will take a variety of data types and bind them as text.  This is how
194
 
         * sqlite internally stores the data anyway, so always binding as text just
195
 
         * means we do the conversion instead of sqlite and is no less efficient.
 
135
         * Bind a value to the SQL statement via a named parameter.
196
136
         *
197
137
         * @param name the named parameter to bind to
198
138
         * @param value the value to bind
202
142
        template< class T >
203
143
        int bind(
204
144
                const std::string &name,
205
 
                T value )
 
145
                const T &value )
206
146
        {
207
147
                return bind( bind_parameter_index( name ), value );
208
148
        }
209
149
 
210
150
        /**
211
 
         * Bind a string value to the SQL statement via a named parameter where the
212
 
         * string value will not change for the duration of the statement.  This
213
 
         * prevents sqlite from taking its own copy of the string.
214
 
         *
215
 
         * @param name the named parameter to bind to
216
 
         * @param value the invariant string value
217
 
         * @param value_length the length of the string including zero-terminator
218
 
         * @returns an sqlite error code
219
 
         * @see sqlite3_bind_text()
220
 
         */
221
 
        int bind_static(
222
 
                const std::string &name,
223
 
                const char *value,
224
 
                unsigned int value_length );
225
 
 
226
 
        /**
227
 
         * Bind a string value to the SQL statement via a named parameter where the
228
 
         * string value will not change for the duration of the statement.  This
229
 
         * prevents a copy of the string being taken.
230
 
         *
231
 
         * @param name the named parameter to bind to
232
 
         * @param value the invariant string value
233
 
         * @returns an sqlite error code
234
 
         * @see sqlite3_bind_text()
235
 
         */
236
 
        int bind_static(
237
 
                const std::string &name,
238
 
                const char *value );
239
 
 
240
 
        /**
241
 
         * Bind a string value to the SQL statement via a named parameter where the
242
 
         * string value will not change for the duration of the statement.  This
243
 
         * prevents a copy of the string being taken.
244
 
         *
245
 
         * @param name the named parameter to bind to
246
 
         * @param value the invariant string value
247
 
         * @returns an sqlite error code
248
 
         * @see sqlite3_bind_text()
249
 
         */
250
 
        int bind_static(
251
 
                const std::string &name,
252
 
                const std::string &value );
253
 
 
254
 
        /**
255
 
         * Bind a NULL value to the SQL statement via a named parameter.
256
 
         *
257
 
         * @param name the named parameter to bind to
258
 
         * @returns an sqlite error code
259
 
         * @see sqlite3_bind_null()
260
 
         */
261
 
        int bind_null(
262
 
                const std::string &name );
263
 
 
264
 
        /**
265
151
         * Stream operator is used to bind values to parameters automatically, in
266
152
         * ascending order.  In addition, the null and set_index() auto-binding
267
153
         * manipulators can be used.
278
164
                return *this;
279
165
        }
280
166
 
 
167
        /**
 
168
         * Bind a string value to the SQL statement via it's index where the value
 
169
         * of that string will not change for the duration of the statement.  This
 
170
         * is more optimal because sqlite will not have to take it's own copy of the
 
171
         * data.
 
172
         *
 
173
         * @param index the index of the parameter to bind to
 
174
         * @param value the invariant string value
 
175
         * @param value_length the length of the string including zero-terminator
 
176
         * @returns an sqlite error code
 
177
         * @see sqlite3_bind_text()
 
178
         */
 
179
        int bind_static(
 
180
                unsigned int index,
 
181
                const char *value,
 
182
                unsigned int value_length );
 
183
 
 
184
        /**
 
185
         * Bind a string value to the SQL statement via it's index where the value
 
186
         * of that string will not change for the duration of the statement.  This
 
187
         * is more optimal because sqlite will not have to take it's own copy of the
 
188
         * data.
 
189
         *
 
190
         * @param index the index of the parameter to bind to
 
191
         * @param value the invariant string value
 
192
         * @returns an sqlite error code
 
193
         * @see sqlite3_bind_text()
 
194
         */
 
195
        int bind_static(
 
196
                unsigned int index,
 
197
                const char *value );
 
198
 
 
199
        /**
 
200
         * Bind a string value to the SQL statement via it's index where the value
 
201
         * of that string will not change for the duration of the statement.  This
 
202
         * is more optimal because sqlite will not have to take it's own copy of the
 
203
         * data.
 
204
         *
 
205
         * @param index the index of the parameter to bind to
 
206
         * @param value the invariant string value
 
207
         * @returns an sqlite error code
 
208
         * @see sqlite3_bind_text()
 
209
         */
 
210
        int bind_static(
 
211
                unsigned int index,
 
212
                const std::string &value );
 
213
 
 
214
        /**
 
215
         * Bind a string value to the SQL statement via a named parameter where the
 
216
         * string value will not change for the duration of the statement.  This
 
217
         * prevents sqlite from taking its own copy of the string.
 
218
         *
 
219
         * @param name the named parameter to bind to
 
220
         * @param value the invariant string value
 
221
         * @param value_length the length of the string including zero-terminator
 
222
         * @returns an sqlite error code
 
223
         * @see sqlite3_bind_text()
 
224
         */
 
225
        int bind_static(
 
226
                const std::string &name,
 
227
                const char *value,
 
228
                unsigned int value_length );
 
229
 
 
230
        /**
 
231
         * Bind a string value to the SQL statement via a named parameter where the
 
232
         * string value will not change for the duration of the statement.  This
 
233
         * prevents a copy of the string being taken.
 
234
         *
 
235
         * @param name the named parameter to bind to
 
236
         * @param value the invariant string value
 
237
         * @returns an sqlite error code
 
238
         * @see sqlite3_bind_text()
 
239
         */
 
240
        int bind_static(
 
241
                const std::string &name,
 
242
                const char *value );
 
243
 
 
244
        /**
 
245
         * Bind a string value to the SQL statement via a named parameter where the
 
246
         * string value will not change for the duration of the statement.  This
 
247
         * prevents a copy of the string being taken.
 
248
         *
 
249
         * @param name the named parameter to bind to
 
250
         * @param value the invariant string value
 
251
         * @returns an sqlite error code
 
252
         * @see sqlite3_bind_text()
 
253
         */
 
254
        int bind_static(
 
255
                const std::string &name,
 
256
                const std::string &value );
 
257
 
 
258
        /**
 
259
         * Bind a NULL value to the SQL statement via it's index.
 
260
         *
 
261
         * @param index the index of the parameter to bind to
 
262
         * @returns an sqlite error code
 
263
         * @see sqlite3_bind_null()
 
264
         */
 
265
        int bind_null(
 
266
                unsigned int index );
 
267
 
 
268
        /**
 
269
         * Bind a NULL value to the SQL statement via a named parameter.
 
270
         *
 
271
         * @param name the named parameter to bind to
 
272
         * @returns an sqlite error code
 
273
         * @see sqlite3_bind_null()
 
274
         */
 
275
        int bind_null(
 
276
                const std::string &name );
 
277
 
 
278
        /**
 
279
         * Bind a string value as a blob to the SQL statement via its index.
 
280
         *
 
281
         * @param name the named parameter to bind to
 
282
         * @param value the blob data value
 
283
         * @param value_length the length of the blob data
 
284
         * @returns an sqlite error code
 
285
         * @see sqlite3_bind_blob()
 
286
         */
 
287
        int bind_blob(
 
288
                unsigned int index,
 
289
                const char *value,
 
290
                unsigned int value_length );
 
291
 
 
292
        /**
 
293
         * Bind a string value as a blob to the SQL statement via its index.
 
294
         *
 
295
         * @param name the named parameter to bind to
 
296
         * @param value the blob data value
 
297
         * @returns an sqlite error code
 
298
         * @see sqlite3_bind_blob()
 
299
         */
 
300
        int bind_blob(
 
301
                unsigned int index,
 
302
                const std::string &value );
 
303
 
 
304
        /**
 
305
         * Bind a string value as a blob to the SQL statement via a named parameter.
 
306
         *
 
307
         * @param name the named parameter to bind to
 
308
         * @param value the blob data value
 
309
         * @param value_length the length of the blob data
 
310
         * @returns an sqlite error code
 
311
         * @see sqlite3_bind_blob()
 
312
         */
 
313
        int bind_blob(
 
314
                const std::string &name,
 
315
                const char *value,
 
316
                unsigned int value_length );
 
317
 
 
318
        /**
 
319
         * Bind a string value as a blob to the SQL statement via a named parameter.
 
320
         *
 
321
         * @param name the named parameter to bind to
 
322
         * @param value the blob data value
 
323
         * @returns an sqlite error code
 
324
         * @see sqlite3_bind_blob()
 
325
         */
 
326
        int bind_blob(
 
327
                const std::string &name,
 
328
                const std::string &value );
 
329
 
281
330
//______________________________________________________________________________
282
331
//                                                                implementation
283
332
protected:
328
377
template< >
329
378
basic_statement &basic_statement::operator << < detail::set_index_t >(
330
379
        const detail::set_index_t &t );
 
380
template< >
 
381
basic_statement &basic_statement::operator << < detail::blob_t >(
 
382
        const detail::blob_t &t );
 
383
 
 
384
 
 
385
// template specialisations for basic_statement::bind()
 
386
template< >
 
387
int basic_statement::bind< int >(
 
388
        unsigned int index,
 
389
        const int &value );
 
390
template< >
 
391
int basic_statement::bind< double >(
 
392
        unsigned int index,
 
393
        const double &value );
331
394
 
332
395
 
333
396
} // namespace detail