Class for storing the component parts of a PostgreSQL/RDBMS datasource URI. More...

#include <qgsdatasourceuri.h>

Public Types
enum	SSLmode { SSLprefer, SSLdisable, SSLallow, SSLrequire }
Public Member Functions
	QgsDataSourceURI ()
	default constructor
	QgsDataSourceURI (QString uri)
	constructor which parses input URI
QString	connectionInfo () const
	return connection part of URI
QString	uri () const
	return complete uri
QString	quotedTablename () const
	quoted table name
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.
void	setConnection (const QString &aService, const QString &aDatabase, const QString &aUsername, const QString &aPassword, SSLmode sslmode=SSLprefer)
	Set all connection related members at once (for the service case)
void	setDatabase (const QString &database)
	Set database.
void	setDataSource (const QString &aSchema, const QString &aTable, const QString &aGeometryColumn, const QString &aSql=QString(), const QString &aKeyColumn=QString())
	Set all data source related members at once.
void	setUsername (QString username)
	set username
void	setPassword (QString password)
	set password
QString	username () const
QString	schema () const
QString	table () const
QString	sql () const
QString	geometryColumn () const
void	setUseEstimatedMetadata (bool theFlag)
	set use Estimated Metadata
bool	useEstimatedMetadata () const
void	clearSchema ()
void	setSql (QString sql)
QString	host () const
QString	database () const
QString	port () const
QString	password () const
enum SSLmode	sslMode () const
QString	service () const
QString	keyColumn () const
void	setKeyColumn (QString column)
Static Public Member Functions
static QString	removePassword (const QString &aUri)
	Removes password element from uris.
Private Member Functions
void	skipBlanks (const QString &uri, int &i)
QString	getValue (const QString &uri, int &i)
QString	escape (const QString &uri, QChar delim) const
Private Attributes
QString	mHost
	host name
QString	mPort
	port the database server listens on
QString	mService
	service name
QString	mDatabase
	database name
QString	mSchema
	schema
QString	mTable
	spatial table
QString	mGeometryColumn
	geometry column
QString	mSql
	SQL query or where clause used to limit features returned from the layer.
QString	mUsername
	username
QString	mPassword
	password
enum SSLmode	mSSLmode
	ssl mode
QString	mKeyColumn
	key column
bool	mUseEstimatedMetadata

Detailed Description

Class 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

Definition at line 30 of file qgsdatasourceuri.h.

Member Enumeration Documentation

enum QgsDataSourceURI::SSLmode

Note:: enumeration added in version 1.1

Enumerator:

SSLprefer
SSLdisable
SSLallow
SSLrequire

Definition at line 34 of file qgsdatasourceuri.h.

Constructor & Destructor Documentation

QgsDataSourceURI::QgsDataSourceURI ( )

default constructor

Definition at line 26 of file qgsdatasourceuri.cpp.

QgsDataSourceURI::QgsDataSourceURI ( QString uri )

constructor which parses input URI

Definition at line 31 of file qgsdatasourceuri.cpp.

References getValue(), mDatabase, mGeometryColumn, mHost, mKeyColumn, mPassword, mPort, mSchema, mService, mSql, mSSLmode, mTable, mUseEstimatedMetadata, mUsername, QgsDebugMsg, skipBlanks(), SSLallow, SSLdisable, SSLprefer, and SSLrequire.

Member Function Documentation

void QgsDataSourceURI::clearSchema ( )

Definition at line 318 of file qgsdatasourceuri.cpp.

References mSchema.

QString QgsDataSourceURI::connectionInfo ( ) const

return connection part of URI

Definition at line 407 of file qgsdatasourceuri.cpp.

References escape(), mDatabase, mHost, mPassword, mPort, mService, mSSLmode, mUsername, SSLallow, SSLdisable, SSLprefer, and SSLrequire.

Referenced by uri().

QString QgsDataSourceURI::database ( ) const

Definition at line 247 of file qgsdatasourceuri.cpp.

References mDatabase.

Referenced by QgsMapLayer::readXML(), setConnection(), setDatabase(), and QgsMapLayer::writeXML().

QString QgsDataSourceURI::escape	(	const QString &	uri,
		QChar	delim = `'\''`
	)		const `[private]`

Definition at line 323 of file qgsdatasourceuri.cpp.

Referenced by connectionInfo(), quotedTablename(), and uri().

QString QgsDataSourceURI::geometryColumn ( ) const

Definition at line 287 of file qgsdatasourceuri.cpp.

References mGeometryColumn.

Referenced by setDataSource().

QString QgsDataSourceURI::getValue	(	const QString &	uri,
		int &	i
	)		`[private]`

Definition at line 340 of file qgsdatasourceuri.cpp.

References QgsDebugMsg, and skipBlanks().

Referenced by QgsDataSourceURI().

QString QgsDataSourceURI::host ( ) const

Definition at line 242 of file qgsdatasourceuri.cpp.

References mHost.

Referenced by setConnection(), and QgsMapLayer::writeXML().

QString QgsDataSourceURI::keyColumn ( ) const

Definition at line 292 of file qgsdatasourceuri.cpp.

References mKeyColumn.

Referenced by setDataSource().

QString QgsDataSourceURI::password ( ) const

Definition at line 252 of file qgsdatasourceuri.cpp.

References mPassword.

Referenced by setConnection(), setPassword(), and QgsMapLayer::writeXML().

QString QgsDataSourceURI::port ( ) const

Definition at line 262 of file qgsdatasourceuri.cpp.

References mPort.

Referenced by setConnection(), and QgsMapLayer::writeXML().

QString QgsDataSourceURI::quotedTablename ( ) const

quoted table name

Definition at line 473 of file qgsdatasourceuri.cpp.

References escape(), mSchema, and mTable.

Referenced by uri().

QString QgsDataSourceURI::removePassword ( const QString & aUri ) [static]

Removes password element from uris.

Definition at line 193 of file qgsdatasourceuri.cpp.

Referenced by QgsMapLayer::publicSource().

QString QgsDataSourceURI::schema ( ) const

Definition at line 272 of file qgsdatasourceuri.cpp.

References mSchema.

Referenced by setDataSource().

QString QgsDataSourceURI::service ( ) const

Definition at line 237 of file qgsdatasourceuri.cpp.

References mService.

Referenced by setConnection().

void QgsDataSourceURI::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:: This optional sslmode parameter has been added in version 1.1

Definition at line 484 of file qgsdatasourceuri.cpp.

References database(), host(), mDatabase, mHost, mPassword, mPort, mSSLmode, mUsername, password(), port(), and username().

Referenced by QgsMapLayer::writeXML().

void QgsDataSourceURI::setConnection	(	const QString &	aService,
		const QString &	aDatabase,
		const QString &	aUsername,
		const QString &	aPassword,
		SSLmode	sslmode = `SSLprefer`
	)

Set all connection related members at once (for the service case)

Note:: This optional sslmode parameter has been added in version 1.7

Definition at line 499 of file qgsdatasourceuri.cpp.

References database(), mDatabase, mPassword, mService, mSSLmode, mUsername, password(), service(), and username().

void QgsDataSourceURI::setDatabase ( const QString & database )

Set database.

Definition at line 525 of file qgsdatasourceuri.cpp.

References database(), and mDatabase.

Referenced by QgsMapLayer::readXML().

void QgsDataSourceURI::setDataSource	(	const QString &	aSchema,
		const QString &	aTable,
		const QString &	aGeometryColumn,
		const QString &	aSql = `QString()`,
		const QString &	aKeyColumn = `QString()`
	)