GDAL

cpl_odbc.h
Go to the documentation of this file.
1 /******************************************************************************
2 * $Id$
3 *
4 * Project: OGR ODBC Driver
5 * Purpose: Declarations for ODBC Access Cover API.
6 * Author: Frank Warmerdam, warmerdam@pobox.com
7 *
8 ******************************************************************************
9 * Copyright (c) 2003, Frank Warmerdam
10 *
11 * Permission is hereby granted, free of charge, to any person obtaining a
12 * copy of this software and associated documentation files (the "Software"),
13 * to deal in the Software without restriction, including without limitation
14 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
15 * and/or sell copies of the Software, and to permit persons to whom the
16 * Software is furnished to do so, subject to the following conditions:
17 *
18 * The above copyright notice and this permission notice shall be included
19 * in all copies or substantial portions of the Software.
20 *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
22 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
24 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
26 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27 * DEALINGS IN THE SOFTWARE.
28 ****************************************************************************/
29
30 #ifndef CPL_ODBC_H_INCLUDED
31 #define CPL_ODBC_H_INCLUDED
32
33 #include "cpl_port.h"
34
35 #ifdef WIN32
36 # include <windows.h>
37 #endif
38
39 #include <sql.h>
40 #include <sqlext.h>
41 #include <odbcinst.h>
42 #include "cpl_string.h"
43
45 #ifdef PATH_MAX
46 # define ODBC_FILENAME_MAX PATH_MAX
47 #else
48 # define ODBC_FILENAME_MAX (255 + 1) /* Max path length */
49 #endif
50
61 class CPL_DLL CPLODBCDriverInstaller
62 {
63 char m_szPathOut[ODBC_FILENAME_MAX];
64 char m_szError[SQL_MAX_MESSAGE_LENGTH];
65 DWORD m_nErrorCode;
66 DWORD m_nUsageCount;
67
68 static bool FindMdbToolsDriverLib( CPLString& osDriverFile );
69 static bool LibraryExists( const char* pszLibPath );
70
71 public:
72
73 // Default constructor.
74 CPLODBCDriverInstaller();
75
93 int InstallDriver( const char* pszDriver, const char* pszPathIn,
94 WORD fRequest = ODBC_INSTALL_COMPLETE );
95
103 static void InstallMdbToolsDriver();
104
121 int RemoveDriver( const char* pszDriverName, int fRemoveDSN = FALSE );
122
124 int GetUsageCount() const { return m_nUsageCount; }
125
130 const char* GetPathOut() const { return m_szPathOut; }
131
136 const char* GetLastError() const { return m_szError; }
137
143 DWORD GetLastErrorCode() const { return m_nErrorCode; }
144 };
145
146 class CPLODBCStatement;
147
148 /* On MSVC SQLULEN is missing in some cases (i.e. VC6)
149 ** but it is always a #define so test this way. On Unix
150 ** it is a typedef so we can't always do this.
151 */
152 #if defined(_MSC_VER) && !defined(SQLULEN) && !defined(_WIN64)
153 # define MISSING_SQLULEN
154 #endif
155
157 #if !defined(MISSING_SQLULEN)
158 /* ODBC types to support 64 bit compilation */
159 # define CPL_SQLULEN SQLULEN
160 # define CPL_SQLLEN SQLLEN
161 #else
162 # define CPL_SQLULEN SQLUINTEGER
163 # define CPL_SQLLEN SQLINTEGER
164 #endif /* ifdef SQLULEN */
165
173 class CPL_DLL CPLODBCSession {
174
175 CPL_DISALLOW_COPY_ASSIGN(CPLODBCSession)
176
177 CPLString m_osLastError{};
178 HENV m_hEnv = nullptr;
179 HDBC m_hDBC = nullptr;
180 int m_bInTransaction = false;
181 int m_bAutoCommit = true;
182
183 public:
184 CPLODBCSession();
185 ~CPLODBCSession();
186
187 int EstablishSession( const char *pszDSN,
188 const char *pszUserid,
189 const char *pszPassword );
190 const char *GetLastError();
191
192 // Transaction handling
193
194 int ClearTransaction();
195 int BeginTransaction();
196 int CommitTransaction();
197 int RollbackTransaction();
199 int IsInTransaction() { return m_bInTransaction; }
200
201 // Essentially internal.
202
203 int CloseSession();
204
205 int Failed( int, HSTMT = nullptr );
207 HDBC GetConnection() { return m_hDBC; }
209 HENV GetEnvironment() { return m_hEnv; }
210
211 bool ConnectToMsAccess( const char * pszName, const char* pszDSNStringTemplate );
212
213 };
214
224 class CPL_DLL CPLODBCStatement {
225
226 CPL_DISALLOW_COPY_ASSIGN(CPLODBCStatement)
227
228 int m_nFlags = 0;
229
230 CPLODBCSession *m_poSession = nullptr;
231 HSTMT m_hStmt = nullptr;
232
233 SQLSMALLINT m_nColCount = 0;
234 char **m_papszColNames = nullptr;
235 SQLSMALLINT *m_panColType = nullptr;
236 char **m_papszColTypeNames = nullptr;
237 CPL_SQLULEN *m_panColSize = nullptr;
238 SQLSMALLINT *m_panColPrecision = nullptr;
239 SQLSMALLINT *m_panColNullable = nullptr;
240 char **m_papszColColumnDef = nullptr;
241
242 char **m_papszColValues = nullptr;
243 CPL_SQLLEN *m_panColValueLengths = nullptr;
244 double *m_padColValuesAsDouble = nullptr;
245
246 int Failed( int );
247
248 char *m_pszStatement = nullptr;
249 size_t m_nStatementMax = 0;
250 size_t m_nStatementLen = 0;
251
252 public:
253
257 enum Flag
258 {
269 RetrieveNumericColumnsAsDouble = 1 << 0,
270 };
271
272 explicit CPLODBCStatement( CPLODBCSession *, int flags = 0 );
273 ~CPLODBCStatement();
274
276 HSTMT GetStatement() { return m_hStmt; }
277
281 int Flags() const { return m_nFlags; }
282
283 // Command buffer related.
284 void Clear();
285 void AppendEscaped( const char * );
286 void Append( const char * );
287 void Append( int );
288 void Append( double );
289 int Appendf( CPL_FORMAT_STRING(const char *), ... ) CPL_PRINT_FUNC_FORMAT (2, 3);
291 const char *GetCommand() { return m_pszStatement; }
292
293 int ExecuteSQL( const char * = nullptr );
294
295 // Results fetching
296 int Fetch( int nOrientation = SQL_FETCH_NEXT,
297 int nOffset = 0 );
298 void ClearColumnData();
299
300 int GetColCount();
301 const char *GetColName( int );
302 short GetColType( int );
303 const char *GetColTypeName( int );
304 short GetColSize( int );
305 short GetColPrecision( int );
306 short GetColNullable( int );
307 const char *GetColColumnDef( int );
308
309 int GetColId( const char * ) const;
310 const char *GetColData( int, const char * = nullptr );
311 const char *GetColData( const char *, const char * = nullptr );
312 int GetColDataLength( int );
313
314 double GetColDataAsDouble( int ) const;
315 double GetColDataAsDouble( const char * ) const;
316
317 int GetRowCountAffected();
318
319 // Fetch special metadata.
320 int GetColumns( const char *pszTable,
321 const char *pszCatalog = nullptr,
322 const char *pszSchema = nullptr );
323 int GetPrimaryKeys( const char *pszTable,
324 const char *pszCatalog = nullptr,
325 const char *pszSchema = nullptr );
326
327 int GetTables( const char *pszCatalog = nullptr,
328 const char *pszSchema = nullptr );
329
330 void DumpResult( FILE *fp, int bShowSchema = FALSE );
331
332 static CPLString GetTypeName( int );
333 static SQLSMALLINT GetTypeMapping( SQLSMALLINT );
334
335 int CollectResultsInfo();
336 };
337
338 #endif
CPL_PRINT_FUNC_FORMAT
#define CPL_PRINT_FUNC_FORMAT(format_idx, arg_idx)
Tag a function to have printf() formatting.
Definition: cpl_port.h:841
CPLString
Convenient string class based on std::string.
Definition: cpl_string.h:319
CPLODBCStatement::GetStatement
HSTMT GetStatement()
Return statement handle.
Definition: cpl_odbc.h:276
CPLODBCSession::GetConnection
HDBC GetConnection()
Return connection handle.
Definition: cpl_odbc.h:207
CPLODBCSession::GetEnvironment
HENV GetEnvironment()
Return GetEnvironment handle.
Definition: cpl_odbc.h:209
CPLODBCStatement
Abstraction for statement, and resultset.
Definition: cpl_odbc.h:224
cpl_string.h
CPLODBCSession
A class representing an ODBC database session.
Definition: cpl_odbc.h:173
CPLODBCDriverInstaller::GetLastError
const char * GetLastError() const
If InstallDriver returns FALSE, then GetLastError then error message can be obtained by calling this ...
Definition: cpl_odbc.h:136
CPLODBCDriverInstaller::GetPathOut
const char * GetPathOut() const
Path of the target directory where the driver should be installed.
Definition: cpl_odbc.h:130
CPLODBCDriverInstaller::GetLastErrorCode
DWORD GetLastErrorCode() const
If InstallDriver returns FALSE, then GetLastErrorCode then error code can be obtained by calling this...
Definition: cpl_odbc.h:143
CPL_FORMAT_STRING
#define CPL_FORMAT_STRING(arg)
Macro into which to wrap the format argument of a printf-like function.
Definition: cpl_port.h:856
cpl_port.h
CPLODBCDriverInstaller::GetUsageCount
int GetUsageCount() const
The usage count of the driver after this function has been called.
Definition: cpl_odbc.h:124
CPLODBCStatement::Flags
int Flags() const
Returns statement flags.
Definition: cpl_odbc.h:281
CPLODBCDriverInstaller
A class providing functions to install or remove ODBC driver.
Definition: cpl_odbc.h:61
CPLODBCSession::IsInTransaction
int IsInTransaction()
Returns whether a transaction is active.
Definition: cpl_odbc.h:199
CPL_DISALLOW_COPY_ASSIGN
#define CPL_DISALLOW_COPY_ASSIGN(ClassName)
Helper to remove the copy and assignment constructors so that the compiler will not generate the defa...
Definition: cpl_port.h:927
CPLODBCStatement::Flag
Flag
Flags which control ODBC statement behavior.
Definition: cpl_odbc.h:257