QGIS API Documentation
2.12.0-Lyon
|
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 More... | |
QgsDataSourceURI (QString uri) | |
constructor which parses input URI More... | |
QgsDataSourceURI (const QByteArray &uri) | |
constructor which parses input encoded URI (generic mode) More... | |
QString | authConfigId () const |
Any associated authentication configuration ID. More... | |
void | clearSchema () |
QString | connectionInfo (bool expandAuthConfig=true) const |
return connection part of URI More... | |
QString | database () const |
void | disableSelectAtId (bool theFlag) |
QByteArray | encodedUri () const |
return complete encoded uri (generic mode) More... | |
QString | geometryColumn () const |
bool | hasParam (const QString &key) const |
Test if param exists (generic mode) More... | |
QString | host () const |
QString | keyColumn () const |
QString | param (const QString &key) const |
Get generic param (generic mode) More... | |
QStringList | params (const QString &key) const |
Get multiple generic param (generic mode) More... | |
QString | password () const |
QString | port () const |
QString | quotedTablename () const |
quoted table name More... | |
int | removeParam (const QString &key) |
Remove generic param (generic mode) More... | |
QString | schema () const |
bool | selectAtIdDisabled () const |
QString | service () const |
void | setAuthConfigId (const QString &authcfg) |
Set authentication configuration ID. More... | |
void | setConnection (const QString &aHost, const QString &aPort, const QString &aDatabase, const QString &aUsername, const QString &aPassword, SSLmode sslmode=SSLprefer, const QString &authConfigId=QString()) |
Set all connection related members at once. More... | |
void | setConnection (const QString &aService, const QString &aDatabase, const QString &aUsername, const QString &aPassword, SSLmode sslmode=SSLprefer, const QString &authConfigId=QString()) |
Set all connection related members at once (for the service case) More... | |
void | setDatabase (const QString &database) |
Set database. More... | |
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. More... | |
void | setEncodedUri (const QByteArray &uri) |
set complete encoded uri (generic mode) More... | |
void | setEncodedUri (const QString &uri) |
set complete encoded uri (generic mode) More... | |
void | setKeyColumn (const QString &column) |
void | setParam (const QString &key, const QString &value) |
Set generic param (generic mode) More... | |
void | setParam (const QString &key, const QStringList &value) |
void | setPassword (const QString &password) |
set password More... | |
void | setSchema (const QString &schema) |
set the table schema More... | |
void | setSql (const QString &sql) |
void | setSrid (const QString &srid) |
void | setUseEstimatedMetadata (bool theFlag) |
set use Estimated Metadata More... | |
void | setUsername (const QString &username) |
set username More... | |
void | setWkbType (QGis::WkbType type) |
QString | sql () const |
QString | srid () const |
enum SSLmode | sslMode () const |
QString | table () const |
QString | uri (bool expandAuthConfig=true) const |
return complete uri More... | |
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. More... | |
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.
QgsDataSourceURI::QgsDataSourceURI | ( | ) |
default constructor
Definition at line 28 of file qgsdatasourceuri.cpp.
QgsDataSourceURI::QgsDataSourceURI | ( | QString | uri | ) |
constructor which parses input URI
Definition at line 38 of file qgsdatasourceuri.cpp.
QgsDataSourceURI::QgsDataSourceURI | ( | const QByteArray & | uri | ) |
constructor which parses input encoded URI (generic mode)
QString QgsDataSourceURI::authConfigId | ( | ) | const |
Any associated authentication configuration ID.
Definition at line 261 of file qgsdatasourceuri.cpp.
void QgsDataSourceURI::clearSchema | ( | ) |
Definition at line 367 of file qgsdatasourceuri.cpp.
QString QgsDataSourceURI::connectionInfo | ( | bool | expandAuthConfig = true | ) | const |
return connection part of URI
Definition at line 461 of file qgsdatasourceuri.cpp.
QString QgsDataSourceURI::database | ( | ) | const |
Definition at line 286 of file qgsdatasourceuri.cpp.
void QgsDataSourceURI::disableSelectAtId | ( | bool | theFlag | ) |
Definition at line 352 of file qgsdatasourceuri.cpp.
QByteArray QgsDataSourceURI::encodedUri | ( | ) | const |
return complete encoded uri (generic mode)
Definition at line 577 of file qgsdatasourceuri.cpp.
QString QgsDataSourceURI::geometryColumn | ( | ) | const |
Definition at line 326 of file qgsdatasourceuri.cpp.
bool QgsDataSourceURI::hasParam | ( | const QString & | key | ) | const |
Test if param exists (generic mode)
Definition at line 722 of file qgsdatasourceuri.cpp.
QString QgsDataSourceURI::host | ( | ) | const |
Definition at line 281 of file qgsdatasourceuri.cpp.
QString QgsDataSourceURI::keyColumn | ( | ) | const |
Definition at line 331 of file qgsdatasourceuri.cpp.
Get generic param (generic mode)
Definition at line 712 of file qgsdatasourceuri.cpp.
QStringList QgsDataSourceURI::params | ( | const QString & | key | ) | const |
Get multiple generic param (generic mode)
Definition at line 717 of file qgsdatasourceuri.cpp.
QString QgsDataSourceURI::password | ( | ) | const |
Definition at line 291 of file qgsdatasourceuri.cpp.
QString QgsDataSourceURI::port | ( | ) | const |
Definition at line 301 of file qgsdatasourceuri.cpp.
QString QgsDataSourceURI::quotedTablename | ( | ) | const |
quoted table name
Definition at line 607 of file qgsdatasourceuri.cpp.
int QgsDataSourceURI::removeParam | ( | const QString & | key | ) |
Remove generic param (generic mode)
Definition at line 707 of file qgsdatasourceuri.cpp.
Removes password element from uris.
Definition at line 227 of file qgsdatasourceuri.cpp.
QString QgsDataSourceURI::schema | ( | ) | const |
Definition at line 311 of file qgsdatasourceuri.cpp.
bool QgsDataSourceURI::selectAtIdDisabled | ( | ) | const |
Definition at line 357 of file qgsdatasourceuri.cpp.
QString QgsDataSourceURI::service | ( | ) | const |
Definition at line 276 of file qgsdatasourceuri.cpp.
void QgsDataSourceURI::setAuthConfigId | ( | const QString & | authcfg | ) |
Set authentication configuration ID.
Definition at line 663 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 , |
||
const QString & | authConfigId = QString() |
||
) |
Set all connection related members at once.
Definition at line 618 of file qgsdatasourceuri.cpp.
void QgsDataSourceURI::setConnection | ( | const QString & | aService, |
const QString & | aDatabase, | ||
const QString & | aUsername, | ||
const QString & | aPassword, | ||
SSLmode | sslmode = SSLprefer , |
||
const QString & | authConfigId = QString() |
||
) |
Set all connection related members at once (for the service case)
Definition at line 635 of file qgsdatasourceuri.cpp.
void QgsDataSourceURI::setDatabase | ( | const QString & | database | ) |
Set database.
Definition at line 668 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 650 of file qgsdatasourceuri.cpp.
void QgsDataSourceURI::setEncodedUri | ( | const QByteArray & | uri | ) |
set complete encoded uri (generic mode)
Definition at line 590 of file qgsdatasourceuri.cpp.
void QgsDataSourceURI::setEncodedUri | ( | const QString & | uri | ) |
set complete encoded uri (generic mode)
Definition at line 602 of file qgsdatasourceuri.cpp.
void QgsDataSourceURI::setKeyColumn | ( | const QString & | column | ) |
Definition at line 336 of file qgsdatasourceuri.cpp.
Set generic param (generic mode)
Definition at line 693 of file qgsdatasourceuri.cpp.
void QgsDataSourceURI::setParam | ( | const QString & | key, |
const QStringList & | value | ||
) |
Definition at line 699 of file qgsdatasourceuri.cpp.
void QgsDataSourceURI::setPassword | ( | const QString & | password | ) |
set password
Definition at line 296 of file qgsdatasourceuri.cpp.
void QgsDataSourceURI::setSchema | ( | const QString & | schema | ) |
set the table schema
Definition at line 372 of file qgsdatasourceuri.cpp.
void QgsDataSourceURI::setSql | ( | const QString & | sql | ) |
Definition at line 362 of file qgsdatasourceuri.cpp.
void QgsDataSourceURI::setSrid | ( | const QString & | srid | ) |
Definition at line 688 of file qgsdatasourceuri.cpp.
void QgsDataSourceURI::setUseEstimatedMetadata | ( | bool | theFlag | ) |
set use Estimated Metadata
Definition at line 342 of file qgsdatasourceuri.cpp.
void QgsDataSourceURI::setUsername | ( | const QString & | username | ) |
set username
Definition at line 271 of file qgsdatasourceuri.cpp.
void QgsDataSourceURI::setWkbType | ( | QGis::WkbType | type | ) |
Definition at line 678 of file qgsdatasourceuri.cpp.
QString QgsDataSourceURI::sql | ( | ) | const |
Definition at line 321 of file qgsdatasourceuri.cpp.
QString QgsDataSourceURI::srid | ( | ) | const |
Definition at line 683 of file qgsdatasourceuri.cpp.
QgsDataSourceURI::SSLmode QgsDataSourceURI::sslMode | ( | ) | const |
Definition at line 306 of file qgsdatasourceuri.cpp.
QString QgsDataSourceURI::table | ( | ) | const |
Definition at line 316 of file qgsdatasourceuri.cpp.
QString QgsDataSourceURI::uri | ( | bool | expandAuthConfig = true | ) | const |
return complete uri
Definition at line 524 of file qgsdatasourceuri.cpp.
bool QgsDataSourceURI::useEstimatedMetadata | ( | ) | const |
Definition at line 347 of file qgsdatasourceuri.cpp.
QString QgsDataSourceURI::username | ( | ) | const |
Definition at line 266 of file qgsdatasourceuri.cpp.
QGis::WkbType QgsDataSourceURI::wkbType | ( | ) | const |
Definition at line 673 of file qgsdatasourceuri.cpp.