QGIS/python/core/qgsdatasourceuri.sip

/** 
\struct QgsDataSourceURI 
\brief Structure for storing the component parts of a PostgreSQL/RDBMS datasource URI.
           
 This structure stores the database connection information, including host, database,
  user name, password, schema, password, and sql where clause
 */
class QgsDataSourceURI
{
%TypeHeaderCode
#include <qgsdatasourceuri.h>
%End

public:
  //! \note enumeration added in version 1.1
  enum SSLmode { SSLprefer, SSLdisable, SSLallow, SSLrequire };

  //! default constructor
  QgsDataSourceURI();
   
  //! constructor which parses input URI
  QgsDataSourceURI(QString uri);
   
  //! connection info
  QString connectionInfo() const;

  //! complete uri
  QString uri() const;

  //! quoted table name
  QString quotedTablename() const;
  
  //! Set all connection related members at once
  //! \note This optional sslmode parameter has been added in version 1.1
  void setConnection(const QString& aHost,
                     const QString& aPort,
                     const QString& aDatabase,
                     const QString& aUsername,
                     const QString& aPassword,
                     SSLmode sslmode = SSLprefer );

  //! Set all connection related members at once
  //! \note added in 1.7
  void setConnection(const QString& service,
                     const QString& aDatabase,
                     const QString& aUsername,
                     const QString& aPassword,
                     SSLmode sslmode = SSLprefer );

  //! Set database
  //! \note added in 1.4
  void setDatabase( const QString &database );
  
  //! Set all data source related members at once
  void setDataSource(const QString& aSchema,
                     const QString& aTable,
                     const QString& aGeometryColumn,
                     const QString& aSql = QString(),
                     const QString& aKeyColumn = QString());

  /** Removes password from uris 
   * @note this method was added in QGIS 1.1
  */
  static QString removePassword( const QString& aUri);
  
  QString username() const;
  QString schema() const;
  QString table() const;
  QString sql() const;
  QString geometryColumn() const;
  
  //! set use Estimated Metadata
  // added in 1.5
  void setUseEstimatedMetadata( bool theFlag );
  bool useEstimatedMetadata() const;

  // added in 1.1
  QString host() const;
  QString database() const;
  QString password() const;
  QString port() const;
  SSLmode sslMode() const;

  // added in 1.7
  QString service() const;

  void setSql(QString sql);

  // added in 1.2
  QString keyColumn() const;
  void setKeyColumn(QString column);
};