1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
/*
* The Mana World Server
* Copyright 2004 The Mana World Development Team
*
* This file is part of The Mana World.
*
* The Mana World is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the Free
* Software Foundation; either version 2 of the License, or any later version.
*
* The Mana World is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along
* with The Mana World; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef PQDATAPROVIDER_H
#define PQDATAPROVIDER_H
#include <iosfwd>
#include <libpq-fe.h>
#include "dataprovider.h"
namespace dal
{
/**
* A PostgreSQL Data Provider.
*/
class PqDataProvider: public DataProvider
{
public:
/**
* Constructor
*/
PqDataProvider()
throw();
/**
* Destructor
*/
~PqDataProvider()
throw();
/**
* Get name of the database backend
*
* @return the database backend name
*/
DbBackends getDbBackend() const
throw();
/**
* Create a connection to the database.
*
* @param dbName the database name.
* @param userName the user name.
* @param password the user password.
*
* @exception DbConnectionFailure if unsuccessful connection.
*/
void connect(const std::string& dbName,
const std::string& userName,
const std::string& password);
/**
* Execute a SQL query.
*
* @param sql the SQL query.
* @param refresh if true, refresh the cache (default = false).
*
* @return a recordset.
*
* @exception DbSqlQueryExecFailure if unsuccessful execution.
* @exception std::runtime_error if trying to query a closed database.
*/
const RecordSet &execSql(const std::string& sql,
const bool refresh = false);
/**
* Close the connection to the database.
*
* @exception DbDisconnectionFailure if unsuccessful disconnection.
*/
void disconnect();
private:
PGconn *mDb; /**< Database connection handle */
};
} // namespace dal
#endif // PQDATAPROVIDER_H
|
