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

  • Committer: edam
  • Date: 2010-07-27 15:46:42 UTC
  • Revision ID: edam@waxworlds.org-20100727154642-1uxrjkpxhp7xl6hq
- moved null_t, exec_t and set_index_t to detail namespace so only their extern instantiations are in the main namespace
- added immediate transation

Show diffs side-by-side

added added

removed removed

include/sqlite3cc/manipulator.h
 
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
// types to represent special manipulators for use with stream operators
 
32
namespace detail
 
33
{
 
34
        struct null_t { };
 
35
        struct exec_t { };
 
36
        struct set_index_t { unsigned int _index; };
 
37
}
 
38
 
 
39
 
 
40
/**
 
41
 * Stream manipulator. When used with a statment's stream operator, this
 
42
 * specifies a NULL value to bind to a parameter. When used with a row's stream
 
43
 * operator, no value is fetched for a column.
 
44
 */
 
45
extern detail::null_t null;
 
46
 
 
47
/**
 
48
 * Stream manipulator. When used with a statment's stream operator, this
 
49
 * indicates that the statement should be executed immediately. Unlike a
 
50
 * statment's exec() method, this will throw on error. Also, it will throw if
 
51
 * the execution returns any result rows. When used with a query's stream
 
52
 * operator, behaviour is the same except that it will not throw when the
 
53
 * execution returns results.
 
54
 */
 
55
extern detail::exec_t exec;
 
56
 
 
57
/**
 
58
 * Stream manipulator. When used with a statment's or a row's stream operator,
 
59
 * this manipulator sets the index used to automatically bind values or get
 
60
 * column values.
 
61
 * @param index the new index
 
62
 */
 
63
detail::set_index_t set_index(
 
64
        unsigned int index );
 
65
 
 
66
 
 
67
} // namespace sqlite
 
68
 
 
69
 
 
70
#endif /* SQLITE3CC_MANIPULATOR_H_ */