QgsDataSourceURI Class Reference

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
	QgsDataSourceURI (const QByteArray &uri)
	constructor which parses input encoded URI (generic mode)
void	clearSchema ()
QString	connectionInfo () const
	return connection part of URI
QString	database () const
void	disableSelectAtId (bool theFlag)
QByteArray	encodedUri () const
	return complete encoded uri (generic mode)
QString	geometryColumn () const
bool	hasParam (const QString &key) const
	Test if param exists (generic mode)
QString	host () const
QString	keyColumn () const
QString	param (const QString &key) const
	Get generic param (generic mode)
QStringList	params (const QString &key) const
	Get multiple generic param (generic mode)
QString	password () const
QString	port () const
QString	quotedTablename () const
	quoted table name
int	removeParam (const QString &key)
	Remove generic param (generic mode)
QString	schema () const
bool	selectAtIdDisabled () const
QString	service () const
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	setEncodedUri (const QByteArray &uri)
	set complete encoded uri (generic mode)
void	setEncodedUri (const QString &uri)
	set complete encoded uri (generic mode)
void	setKeyColumn (QString column)
void	setParam (const QString &key, const QString &value)
	Set generic param (generic mode)
void	setParam (const QString &key, const QStringList &value)
void	setPassword (QString password)
	set password
void	setSql (QString sql)
void	setSrid (QString srid)
void	setUseEstimatedMetadata (bool theFlag)
	set use Estimated Metadata
void	setUsername (QString username)
	set username
void	setWkbType (QGis::WkbType type)
QString	sql () const
QString	srid () const
enum SSLmode	sslMode () const
QString	table () const
QString	uri () const
	return complete uri
bool	useEstimatedMetadata () const
QString	username () const
QGis::WkbType	wkbType () const

Static Public Member Functions
static QString	removePassword (const QString &aUri)
	Removes password element from uris.

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

Extended to support generic params so that it may be used by any provider. The 2 modes (the old - RDMS specific and the new generic) may not yet be mixed. (Radim Blazek 4/2012)

Definition at line 35 of file qgsdatasourceuri.h.

Member Enumeration Documentation

enum QgsDataSourceURI::SSLmode

Enumerator:

SSLprefer
SSLdisable
SSLallow
SSLrequire

Definition at line 38 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 36 of file qgsdatasourceuri.cpp.

QgsDataSourceURI::QgsDataSourceURI

(

const QByteArray &

uri

)

constructor which parses input encoded URI (generic mode)

Member Function Documentation

void QgsDataSourceURI::clearSchema

(

)

Definition at line 385 of file qgsdatasourceuri.cpp.

QString QgsDataSourceURI::connectionInfo

(

)

const

return connection part of URI

Definition at line 474 of file qgsdatasourceuri.cpp.

QString QgsDataSourceURI::database

(

)

const

Definition at line 304 of file qgsdatasourceuri.cpp.

void QgsDataSourceURI::disableSelectAtId

(

bool

theFlag

)

Definition at line 370 of file qgsdatasourceuri.cpp.

QByteArray QgsDataSourceURI::encodedUri

(

)

const

return complete encoded uri (generic mode)

Definition at line 617 of file qgsdatasourceuri.cpp.

QString QgsDataSourceURI::geometryColumn

(

)

const

Definition at line 344 of file qgsdatasourceuri.cpp.

bool QgsDataSourceURI::hasParam

(

const QString &

key

)

const

Test if param exists (generic mode)

Definition at line 753 of file qgsdatasourceuri.cpp.

QString QgsDataSourceURI::host

(

)

const

Definition at line 299 of file qgsdatasourceuri.cpp.

QString QgsDataSourceURI::keyColumn

(

)

const

Definition at line 349 of file qgsdatasourceuri.cpp.

QString QgsDataSourceURI::param

(

const QString &

key

)

const

Get generic param (generic mode)

Definition at line 743 of file qgsdatasourceuri.cpp.

QStringList QgsDataSourceURI::params

(

const QString &

key

)

const

Get multiple generic param (generic mode)

Definition at line 748 of file qgsdatasourceuri.cpp.

QString QgsDataSourceURI::password

(

)

const

Definition at line 309 of file qgsdatasourceuri.cpp.

QString QgsDataSourceURI::port

(

)

const

Definition at line 319 of file qgsdatasourceuri.cpp.

QString QgsDataSourceURI::quotedTablename

(

)

const

quoted table name

Definition at line 647 of file qgsdatasourceuri.cpp.

int QgsDataSourceURI::removeParam

(

const QString &

key

)

Remove generic param (generic mode)

Definition at line 738 of file qgsdatasourceuri.cpp.

QString QgsDataSourceURI::removePassword ( const QString &  aUri )

static

Removes password element from uris.

Definition at line 250 of file qgsdatasourceuri.cpp.

QString QgsDataSourceURI::schema

(

)

const

Definition at line 329 of file qgsdatasourceuri.cpp.

bool QgsDataSourceURI::selectAtIdDisabled

(

)

const

Definition at line 375 of file qgsdatasourceuri.cpp.

QString QgsDataSourceURI::service

(

)

const

Definition at line 294 of file qgsdatasourceuri.cpp.

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.

Definition at line 658 of file qgsdatasourceuri.cpp.

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)

Definition at line 673 of file qgsdatasourceuri.cpp.

void QgsDataSourceURI::setDatabase

(

const QString &

database

)

Set database.

Definition at line 699 of file qgsdatasourceuri.cpp.

void QgsDataSourceURI::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.

Definition at line 686 of file qgsdatasourceuri.cpp.

void QgsDataSourceURI::setEncodedUri

(

const QByteArray &

uri

)

set complete encoded uri (generic mode)

Definition at line 630 of file qgsdatasourceuri.cpp.

void QgsDataSourceURI::setEncodedUri

(

const QString &

uri

)

set complete encoded uri (generic mode)

Definition at line 642 of file qgsdatasourceuri.cpp.

void QgsDataSourceURI::setKeyColumn

(

QString

column

)

Definition at line 354 of file qgsdatasourceuri.cpp.

void QgsDataSourceURI::setParam	(	const QString &	key,
		const QString &	value
	)

Set generic param (generic mode)

Definition at line 724 of file qgsdatasourceuri.cpp.

void QgsDataSourceURI::setParam	(	const QString &	key,
		const QStringList &	value
	)

Definition at line 730 of file qgsdatasourceuri.cpp.

void QgsDataSourceURI::setPassword

(

QString

password

)

set password

Definition at line 314 of file qgsdatasourceuri.cpp.

void QgsDataSourceURI::setSql

(

QString

sql

)

Definition at line 380 of file qgsdatasourceuri.cpp.

void QgsDataSourceURI::setSrid

(

QString

srid

)

Definition at line 719 of file qgsdatasourceuri.cpp.

void QgsDataSourceURI::setUseEstimatedMetadata

(

bool

theFlag

)

set use Estimated Metadata

Definition at line 360 of file qgsdatasourceuri.cpp.

void QgsDataSourceURI::setUsername

(

QString

username

)

set username

Definition at line 289 of file qgsdatasourceuri.cpp.

void QgsDataSourceURI::setWkbType

(

QGis::WkbType

type

)

Definition at line 709 of file qgsdatasourceuri.cpp.

QString QgsDataSourceURI::sql

(

)

const

Definition at line 339 of file qgsdatasourceuri.cpp.

QString QgsDataSourceURI::srid

(

)

const

Definition at line 714 of file qgsdatasourceuri.cpp.

QgsDataSourceURI::SSLmode QgsDataSourceURI::sslMode

(

)

const

Definition at line 324 of file qgsdatasourceuri.cpp.

QString QgsDataSourceURI::table

(

)

const

Definition at line 334 of file qgsdatasourceuri.cpp.

QString QgsDataSourceURI::uri

(

)

const

return complete uri

Definition at line 522 of file qgsdatasourceuri.cpp.

bool QgsDataSourceURI::useEstimatedMetadata

(

)

const

Definition at line 365 of file qgsdatasourceuri.cpp.

QString QgsDataSourceURI::username

(

)

const

Definition at line 284 of file qgsdatasourceuri.cpp.

QGis::WkbType QgsDataSourceURI::wkbType

(

)

const

Definition at line 704 of file qgsdatasourceuri.cpp.

---

The documentation for this class was generated from the following files:

• /tmp/buildd/qgis-2.8.2+12wheezy/src/core/qgsdatasourceuri.h
• /tmp/buildd/qgis-2.8.2+12wheezy/src/core/qgsdatasourceuri.cpp