qgsdatasourceuri.h

Go to the documentation of this file.

/***************************************************************************
      qgsdatasourceuri.h  -  Structure to contain the component parts
                             of a data source URI
                             -------------------
    begin                : Dec 5, 2004
    copyright            : (C) 2004 by Gary E.Sherman
    email                : sherman at mrcc.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 QGSDATASOURCEURI_H
#define QGSDATASOURCEURI_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgshttpheaders.h"
#include "qgswkbtypes.h"
 
#include <QMap>
#include <QSet>
#include <QString>
 
using namespace Qt::StringLiterals;

class CORE_EXPORT QgsDataSourceUri
{
    Q_GADGET
  public:
    enum SslMode
    {
      SslPrefer,
      SslDisable,
      SslAllow,
      SslRequire,
      SslVerifyCa,
      SslVerifyFull
    };
    Q_ENUM( SslMode )
 
    QgsDataSourceUri();

    QgsDataSourceUri( const QString &uri );

    QgsDataSourceUri( const QByteArray &uri ) SIP_SKIP;

    QString connectionInfo( bool expandAuthConfig = true ) const;

    QString uri( bool expandAuthConfig = true ) const;

    QByteArray encodedUri() const;

    void setEncodedUri( const QByteArray &uri ) SIP_SKIP;

    void setEncodedUri( const QString &uri );

    QString quotedTablename() const;

    void setParam( const QString &key, const QString &value );

    void setParam( const QString &key, const QStringList &value ) SIP_PYNAME( setParamList );

    int removeParam( const QString &key );

    QString param( const QString &key ) const;

    QStringList params( const QString &key ) const;

    bool hasParam( const QString &key ) const;

    void setConnection(
      const QString &aHost, const QString &aPort, const QString &aDatabase, const QString &aUsername, const QString &aPassword, SslMode sslmode = SslPrefer, const QString &authConfigId = QString()
    );

    void setConnection( const QString &aService, const QString &aDatabase, const QString &aUsername, const QString &aPassword, SslMode sslmode = SslPrefer, const QString &authConfigId = QString() );

    void setDatabase( const QString &database );

    void setDataSource( const QString &aSchema, const QString &aTable, const QString &aGeometryColumn, const QString &aSql = QString(), const QString &aKeyColumn = QString() );

    void setAuthConfigId( const QString &authcfg );

    void setUsername( const QString &username );

    void setPassword( const QString &password );

    static QString removePassword( const QString &aUri, bool hide = false );

    QString authConfigId() const;

    QString username() const;

    QString schema() const;

    QString table() const;

    QString sql() const;

    QString geometryColumn() const;

    void setUseEstimatedMetadata( bool flag );

    bool useEstimatedMetadata() const;

    void disableSelectAtId( bool flag );

    bool selectAtIdDisabled() const;

    void clearSchema();

    void setSchema( const QString &schema );

    void setSql( const QString &sql );

    void setHost( const QString &host );

    QString host() const;

    QString database() const;

    void setPort( const QString &port );

    QString port() const;

    QString driver() const;

    void setDriver( const QString &driver );

    QString password() const;

    void setSslMode( SslMode mode );

    SslMode sslMode() const;

    void setService( const QString &service );

    QString service() const;

    QString keyColumn() const;

    void setKeyColumn( const QString &column );

    Qgis::WkbType wkbType() const;

    void setWkbType( Qgis::WkbType type );

    QString srid() const;

    void setSrid( const QString &srid );

    static SslMode decodeSslMode( const QString &sslMode );

    static QString encodeSslMode( SslMode sslMode );

    void setTable( const QString &table );

    void setGeometryColumn( const QString &geometryColumn );

    QSet<QString> parameterKeys() const;
 
#ifndef SIP_RUN
    QgsHttpHeaders httpHeaders() const { return mHttpHeaders; }
#endif

    QgsHttpHeaders &httpHeaders() { return mHttpHeaders; }

    QString httpHeader( const QString &key ) { return mHttpHeaders[key].toString(); }

    void setHttpHeaders( const QgsHttpHeaders &headers ) { mHttpHeaders = headers; }
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsDataSourceUri: %1>"_s.arg( sipCpp->uri( false ) );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
      bool operator==( const QgsDataSourceUri &other ) const;
    bool operator!=( const QgsDataSourceUri &other ) const;
 
  private:
    void skipBlanks( const QString &uri, int &i );
    QString getValue( const QString &uri, int &i );
    QString escape( const QString &uri, QChar delim ) const;
 
    /* data */

    QString mHost;
    QString mPort;
    QString mDriver;
    QString mService;
    QString mDatabase;
    QString mSchema;
    QString mTable;
    QString mGeometryColumn;
    QString mSql;
    QString mAuthConfigId;
    QString mUsername;
    QString mPassword;
    SslMode mSSLmode = SslPrefer;
    QString mKeyColumn;
    bool mUseEstimatedMetadata = false;
    bool mSelectAtIdDisabled = false;
    bool mSelectAtIdDisabledSet = false;
    Qgis::WkbType mWkbType = Qgis::WkbType::Unknown;
    QString mSrid;
    QMultiMap<QString, QString> mParams;
    QgsHttpHeaders mHttpHeaders;
};
 
#endif //QGSDATASOURCEURI_H