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.h"

#include <QMap>

class CORE_EXPORT QgsDataSourceURI
{
  public:
    enum SSLmode { SSLprefer, SSLdisable, SSLallow, SSLrequire, SSLverifyCA, SSLverifyFull };

    QgsDataSourceURI();

    QgsDataSourceURI( QString uri );

    QgsDataSourceURI( const QByteArray & uri );

    QString connectionInfo( bool expandAuthConfig = true ) const;

    QString uri( bool expandAuthConfig = true ) const;

    QByteArray encodedUri() const;

    // \note not available in python bindings
    void setEncodedUri( const QByteArray & uri );

    void setEncodedUri( const QString & uri );

    QString quotedTablename() const;

    // \note if key exists, another is inserted
    void setParam( const QString &key, const QString &value );
    void setParam( const QString &key, const QStringList &value );

    // \note remove all occurrences of key, returns number of params removed
    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 );

    QString authConfigId() const;

    QString username() const;

    QString schema() const;

    QString table() const;

    QString sql() const;

    QString geometryColumn() const;

    void setUseEstimatedMetadata( bool theFlag );

    bool useEstimatedMetadata() const;

    void disableSelectAtId( bool theFlag );
    bool selectAtIdDisabled() const;

    void clearSchema();

    // @note added in 2.11
    void setSchema( const QString& schema );

    void setSql( const QString& sql );

    QString host() const;
    QString database() const;
    QString port() const;
    // @note added in QGIS 2.16
    QString driver() const;
    // @note added in QGIS 2.16
    void setDriver( const QString& driver );
    QString password() const;
    enum SSLmode sslMode() const;

    QString service() const;

    QString keyColumn() const;
    void setKeyColumn( const QString& column );

    Q_DECL_DEPRECATED QGis::WkbType wkbType() const;

    QgsWKBTypes::Type newWkbType() const;

    Q_DECL_DEPRECATED void setWkbType( QGis::WkbType type );

    void setWkbType( QgsWKBTypes::Type type );

    QString srid() const;
    void setSrid( const QString& srid );

  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;
    enum SSLmode mSSLmode;
    QString mKeyColumn;
    bool mUseEstimatedMetadata;
    bool mSelectAtIdDisabled;
    QgsWKBTypes::Type mWkbType;
    QString mSrid;
    QMap<QString, QString> mParams;
};

#endif //QGSDATASOURCEURI_H