qgssqliteutils.h

Go to the documentation of this file.

/***************************************************************************
                          qgssqliteutils.h
                           -------------------
    begin                : Nov, 2017
    copyright            : (C) 2017 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program 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     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSSQLITEUTILS_H
#define QGSSQLITEUTILS_H
 
#include <memory>
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QString>
 
struct sqlite3;
struct sqlite3_stmt;
class QVariant;
 
#ifndef SIP_RUN

struct CORE_EXPORT QgsSqlite3Closer
{
    void operator()( sqlite3 *database ) const;
};

struct CORE_EXPORT QgsSqlite3StatementFinalizer
{
    void operator()( sqlite3_stmt *statement ) const;
};

class CORE_EXPORT sqlite3_statement_unique_ptr : public std::unique_ptr< sqlite3_stmt, QgsSqlite3StatementFinalizer>
{
  public:
    int step();

    QString columnName( int column ) const;

    QString columnAsText( int column ) const;

    QByteArray columnAsBlob( int column ) const;

    qlonglong columnAsInt64( int column ) const;

    double columnAsDouble( int column ) const;

    int columnCount() const;
};
 

class CORE_EXPORT sqlite3_database_unique_ptr : public std::unique_ptr< sqlite3, QgsSqlite3Closer>
{
  public:
    int open( const QString &path );

    int open_v2( const QString &path, int flags, const char *zVfs );

    QString errorMessage() const;

    sqlite3_statement_unique_ptr prepare( const QString &sql, int &resultCode SIP_OUT ) const;

    int exec( const QString &sql, QString &errorMessage SIP_OUT ) const;
};

QString CORE_EXPORT qgs_sqlite3_mprintf( const char *format, ... );
 
#endif

class CORE_EXPORT QgsSqliteUtils
{
  public:
    static QString quotedString( const QString &value );

    static QString quotedIdentifier( const QString &identifier );

    static QString quotedValue( const QVariant &value );

    static QStringList systemTables();

    static QSet<QString> uniqueFields( sqlite3 *connection, const QString &tableName, QString &errorMessage ) SIP_SKIP;

    static long long nextSequenceValue( sqlite3 *connection, const QString &tableName, QString errorMessage ) SIP_SKIP;
};
 
#endif // QGSSQLITEUTILS_H