qgsabstractdatabaseproviderconnection.h

Go to the documentation of this file.

/***************************************************************************
  qgsabstractdatabaseproviderconnection.h - QgsAbstractDatabaseProviderConnection

 ---------------------
 begin                : 2.8.2019
 copyright            : (C) 2019 by Alessandro Pasotti
 email                : elpaso at itopen dot it
 ***************************************************************************
 *                                                                         *
 *   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 QGSABSTRACTDATABASEPROVIDERCONNECTION_H
#define QGSABSTRACTDATABASEPROVIDERCONNECTION_H

#include "qgsabstractproviderconnection.h"
#include "qgscoordinatereferencesystem.h"
#include "qgis_core.h"
#include "qgsfields.h"
#include "qgsexception.h"

#include <QObject>

class CORE_EXPORT QgsAbstractDatabaseProviderConnection : public QgsAbstractProviderConnection
{

    Q_GADGET

  public:

    enum TableFlag
    {
      Aspatial = 1 << 1,          
      Vector = 1 << 2,            
      Raster = 1 << 3,            
      View = 1 << 4,              
      MaterializedView = 1 << 5,  
    };

    Q_ENUMS( TableFlag )
    Q_DECLARE_FLAGS( TableFlags, TableFlag )
    Q_FLAG( TableFlags )

    
    struct CORE_EXPORT TableProperty
    {

#ifdef SIP_RUN
        SIP_PYOBJECT __repr__();
        % MethodCode
        QString str = QStringLiteral( "<QgsAbstractDatabaseProviderConnection.TableProperty: '%1'>" ).arg( sipCpp->tableName() );
        sipRes = PyUnicode_FromString( str.toUtf8().constData() );
        % End
#endif

        struct CORE_EXPORT GeometryColumnType
        {
#ifdef SIP_RUN
          SIP_PYOBJECT __repr__();
          % MethodCode
          QString str = QStringLiteral( "<QgsAbstractDatabaseProviderConnection.TableProperty.GeometryColumnType: '%1, %2'>" ).arg( QgsWkbTypes::displayString( sipCpp->wkbType ), sipCpp->crs.authid() );
          sipRes = PyUnicode_FromString( str.toUtf8().constData() );
          % End
#endif
          QgsWkbTypes::Type wkbType;
          QgsCoordinateReferenceSystem crs;

          inline bool operator==( const GeometryColumnType &other ) const
          {
            return this->crs == other.crs && this->wkbType == other.wkbType;
          }
        };

      public:

        QString tableName() const;

        void setTableName( const QString &name );

        void addGeometryColumnType( const QgsWkbTypes::Type &type, const QgsCoordinateReferenceSystem &crs );

        QList<QgsAbstractDatabaseProviderConnection::TableProperty::GeometryColumnType> geometryColumnTypes() const;

        void setGeometryColumnTypes( const QList<QgsAbstractDatabaseProviderConnection::TableProperty::GeometryColumnType> &geometryColumnTypes );

        QString defaultName() const;

        TableProperty at( int index ) const;

        QString schema() const;

        void setSchema( const QString &schema );

        QString geometryColumn() const;

        void setGeometryColumn( const QString &geometryColumn );

        QStringList primaryKeyColumns() const;

        void setPrimaryKeyColumns( const QStringList &primaryKeyColumns );

        QList<QgsCoordinateReferenceSystem> crsList() const;

        TableFlags flags() const;

        void setFlags( const TableFlags &flags );

        QString comment() const;

        void setComment( const QString &comment );

        QVariantMap info() const;

        void setInfo( const QVariantMap &info );

        int geometryColumnCount() const;

        void setGeometryColumnCount( int geometryColumnCount );

        void setFlag( const TableFlag &flag );

        int maxCoordinateDimensions() const;


      private:

        QList<GeometryColumnType>    mGeometryColumnTypes;
        QString                       mSchema;
        QString                       mTableName;
        QString                       mGeometryColumn;
        int                           mGeometryColumnCount;
        QStringList                   mPkColumns;
        TableFlags                    mFlags;
        QString                       mComment;
        QVariantMap                   mInfo;
    };

    enum Capability
    {
      CreateVectorTable = 1 << 1,   
      DropRasterTable = 1 << 2,     
      DropVectorTable = 1 << 3,     
      RenameVectorTable = 1 << 4,   
      RenameRasterTable = 1 << 5,   
      CreateSchema = 1 << 6,        
      DropSchema = 1 << 7,          
      RenameSchema = 1 << 8,        
      ExecuteSql = 1 << 9,          
      Vacuum = 1 << 10,             
      Tables = 1 << 11,             
      Schemas = 1 << 12,            
      SqlLayers = 1 << 13,          
      TableExists = 1 << 14,        
      Spatial = 1 << 15,            
    };

    Q_ENUM( Capability )
    Q_DECLARE_FLAGS( Capabilities, Capability )
    Q_FLAG( Capabilities )

    
    QgsAbstractDatabaseProviderConnection( const QString &name );

    QgsAbstractDatabaseProviderConnection( const QString &uri, const QVariantMap &configuration );


    // Public interface

    Capabilities capabilities() const;

    // Operations interface

    virtual void createVectorTable( const QString &schema, const QString &name, const QgsFields &fields, QgsWkbTypes::Type wkbType, const QgsCoordinateReferenceSystem &srs, bool overwrite, const QMap<QString, QVariant> *options ) const SIP_THROW( QgsProviderConnectionException );

    virtual bool tableExists( const QString &schema, const QString &name ) const SIP_THROW( QgsProviderConnectionException );

    virtual void dropVectorTable( const QString &schema, const QString &name ) const SIP_THROW( QgsProviderConnectionException );

    virtual void dropRasterTable( const QString &schema, const QString &name ) const SIP_THROW( QgsProviderConnectionException );

    virtual void renameVectorTable( const QString &schema, const QString &name, const QString &newName ) const SIP_THROW( QgsProviderConnectionException );

    virtual void renameRasterTable( const QString &schema, const QString &name, const QString &newName ) const SIP_THROW( QgsProviderConnectionException );

    virtual void createSchema( const QString &name ) const SIP_THROW( QgsProviderConnectionException );

    virtual void dropSchema( const QString &name, bool force = false ) const SIP_THROW( QgsProviderConnectionException );

    virtual void renameSchema( const QString &name, const QString &newName ) const SIP_THROW( QgsProviderConnectionException );

    virtual QList<QList<QVariant>> executeSql( const QString &sql ) const SIP_THROW( QgsProviderConnectionException );

    virtual void vacuum( const QString &schema, const QString &name ) const SIP_THROW( QgsProviderConnectionException );

    virtual QList<QgsAbstractDatabaseProviderConnection::TableProperty> tables( const QString &schema = QString(), const QgsAbstractDatabaseProviderConnection::TableFlags &flags = nullptr ) const SIP_SKIP;

    QList<QgsAbstractDatabaseProviderConnection::TableProperty> tablesInt( const QString &schema = QString(), const int flags = 0 ) const SIP_THROW( QgsProviderConnectionException ) SIP_PYNAME( tables );


    // TODO: return more schema information and not just the name

    virtual QStringList schemas() const SIP_THROW( QgsProviderConnectionException );

  protected:


    void checkCapability( Capability capability ) const;

    Capabilities mCapabilities = nullptr SIP_SKIP;

};

Q_DECLARE_OPERATORS_FOR_FLAGS( QgsAbstractDatabaseProviderConnection::Capabilities )

#endif // QGSABSTRACTDATABASEPROVIDERCONNECTION_H