/sqlite3cc

To get this branch, use:
bzr branch http://bzr.ed.am/sqlite3cc
2 by edam
- further initial development
1
/*
2
 * manipulator.h
3
 *
4
 * Copyright (C) 2009 Tim Marston <edam@waxworlds.org>
5
 *
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.
18
 *
19
 * You should have received a copy of the GNU Lesser General Public License
20
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
21
 */
22
23
#ifndef SQLITE3CC_MANIPULATOR_H_
24
#define SQLITE3CC_MANIPULATOR_H_
25
26
27
namespace sqlite
28
{
29
30
31
struct _null_t { };
32
struct _exec_t { };
33
struct _set_index_t { unsigned int _index; };
34
35
36
/**
37
 * Stream manipulator. When used with a statment's stream operator, this
38
 * specifies a NULL value to bind to a parameter. When used with a row's stream
39
 * operator, no value is fetched for a column.
40
 */
41
extern _null_t null;
42
43
/**
44
 * Stream manipulator. When used with a statment's stream operator, this
45
 * indicates that the statement should be executed immediately. Unlike a
46
 * statment's exec() method, this will throw on error. Also, it will throw if
47
 * the execution returns any result rows. When used with a query's stream
48
 * operator, behaviour is the same except that it will not throw when the
49
 * execution returns results.
50
 */
51
extern _exec_t exec;
52
53
/**
54
 * Stream manipulator. When used with a statment's or a row's stream operator,
55
 * this manipulator sets the index used to automatically bind values or get
56
 * column values.
57
 * @param index the new index
58
 */
59
_set_index_t set_index(
60
	unsigned int index );
61
62
63
} // namespace sqlite
64
65
66
#endif /* SQLITE3CC_MANIPULATOR_H_ */