QGIS API Documentation  3.9.0-Master (224899f119)
qgssqliteutils.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgssqliteutils.h
3  -------------------
4  begin : Nov, 2017
5  copyright : (C) 2017 by Nyall Dawson
6  email : nyall dot dawson at gmail dot com
7  ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
18 #ifndef QGSSQLITEUTILS_H
19 #define QGSSQLITEUTILS_H
20 
21 #include "qgis_core.h"
22 #include "qgis_sip.h"
23 
24 #include <memory>
25 #include <QString>
26 
27 struct sqlite3;
28 struct sqlite3_stmt;
29 class QVariant;
30 
31 #ifndef SIP_RUN
32 
40 struct CORE_EXPORT QgsSqlite3Closer
41 {
42 
46  void operator()( sqlite3 *database );
47 };
48 
52 struct CORE_EXPORT QgsSqlite3StatementFinalizer
53 {
54 
58  void operator()( sqlite3_stmt *statement );
59 };
60 
69 class CORE_EXPORT sqlite3_statement_unique_ptr : public std::unique_ptr< sqlite3_stmt, QgsSqlite3StatementFinalizer>
70 {
71  public:
72 
76  int step();
77 
81  QString columnName( int column ) const;
82 
86  QString columnAsText( int column ) const;
87 
91  qlonglong columnAsInt64( int column ) const;
92 
96  double columnAsDouble( int column ) const;
97 
101  int columnCount() const;
102 };
103 
104 
113 class CORE_EXPORT sqlite3_database_unique_ptr : public std::unique_ptr< sqlite3, QgsSqlite3Closer>
114 {
115  public:
116 
122  int open( const QString &path );
123 
129  int open_v2( const QString &path, int flags, const char *zVfs );
130 
134  QString errorMessage() const;
135 
140  sqlite3_statement_unique_ptr prepare( const QString &sql, int &resultCode SIP_OUT ) const;
141 
150  int exec( const QString &sql, QString &errorMessage SIP_OUT ) const;
151 };
152 
158 QString CORE_EXPORT QgsSqlite3Mprintf( const char *format, ... );
159 
160 #endif
161 
167 class CORE_EXPORT QgsSqliteUtils
168 {
169  public:
170 
175  static QString quotedString( const QString &value );
176 
182  static QString quotedIdentifier( const QString &identifier );
183 
190  static QString quotedValue( const QVariant &value );
191 
197  static QStringList systemTables();
198 };
199 
200 #endif // QGSSQLITEUTILS_H
Closes a sqlite3 database.
Unique pointer for sqlite3 prepared statements, which automatically finalizes the statement when the ...
Contains utilities for working with Sqlite data sources.
std::unique_ptr< GEOSGeometry, GeosDeleter > unique_ptr
Scoped GEOS pointer.
Definition: qgsgeos.h:79
QString CORE_EXPORT QgsSqlite3Mprintf(const char *format,...)
Wraps sqlite3_mprintf() by automatically freeing the memory.
struct sqlite3 sqlite3
Finalizes an sqlite3 statement.
Unique pointer for sqlite3 databases, which automatically closes the database when the pointer goes o...
#define SIP_OUT
Definition: qgis_sip.h:58