1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
/** \ingroup core
* 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)
*/
class QgsDataSourceURI
{
%TypeHeaderCode
#include <qgsdatasourceuri.h>
%End
public:
enum SSLmode { SSLprefer, SSLdisable, SSLallow, SSLrequire, SSLverifyCA, SSLverifyFull };
//! default constructor
QgsDataSourceURI();
//! constructor which parses input URI
QgsDataSourceURI( QString uri );
//! return connection part of URI
QString connectionInfo( bool expandAuthConfig = true ) const;
//! return complete uri
QString uri( bool expandAuthConfig = true ) const;
//! return complete encoded uri (generic mode)
QByteArray encodedUri() const;
//! set complete encoded uri (generic mode)
// \note not available in python bindings
// void setEncodedUri( const QByteArray & uri );
//! set complete encoded uri (generic mode)
void setEncodedUri( const QString & uri );
//! quoted table name
QString quotedTablename() const;
//! Set generic param (generic mode)
// \note if key exists, another is inserted
void setParam( const QString &key, const QString &value );
//! @note available in python as setParamList
void setParam( const QString &key, const QStringList &value ) /PyName=setParamList/;
//! Remove generic param (generic mode)
// \note remove all occurrences of key, returns number of params removed
int removeParam( const QString &key );
//! Get generic param (generic mode)
QString param( const QString &key ) const;
//! Get multiple generic param (generic mode)
QStringList params( const QString &key ) const;
//! Test if param exists (generic mode)
bool hasParam( const QString &key ) const;
//! Set all connection related members at once
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 (for the service case)
void setConnection( const QString& aService,
const QString& aDatabase,
const QString& aUsername,
const QString& aPassword,
SSLmode sslmode = SSLprefer,
const QString& authConfigId = QString() );
//! Set database
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() );
//! Set authentication configuration ID
void setAuthConfigId( const QString& authcfg );
//! set username
void setUsername( const QString& username );
//! set password
void setPassword( const QString& password );
//! Removes password element from uris
static QString removePassword( const QString& aUri );
//! Any associated authentication configuration ID
QString authConfigId() const;
//! Returns the username
QString username() const;
//! Returns the schema
QString schema() const;
//! Returns the table
QString table() const;
//! Returns the SQL query
QString sql() const;
//! Return the name of the geometry column
QString geometryColumn() const;
//! set use Estimated Metadata
void setUseEstimatedMetadata( bool theFlag );
//! Returns true if estimated metadata are used
bool useEstimatedMetadata() const;
//! Set to true to disable selection by id
void disableSelectAtId( bool theFlag );
//! Returns whether the selection by id is disabled
bool selectAtIdDisabled() const;
//! Clears the schema
void clearSchema();
//! set the table schema
// @note added in 2.11
void setSchema( const QString& schema );
//! Sets the SQL query
void setSql( const QString& sql );
//! Returns the host
QString host() const;
//! Returns the database
QString database() const;
//! Returns the port
QString port() const;
//! Returns the driver
// @note added in QGIS 2.16
QString driver() const;
//! Sets the driver name
// @note added in QGIS 2.16
void setDriver( const QString& driver );
//! Returns the password
QString password() const;
//! Returns the SSL mode
SSLmode sslMode() const;
//! Returns the service name
QString service() const;
//! Returns the name of the (primary) key column
QString keyColumn() const;
//! Sets the name of the (primary) key column
void setKeyColumn( const QString& column );
/** The (old) wkb type.
@deprecated Will return QgsWKBTypes::Type in 3.0. Prefer newWkbType() in the meantime */
QGis::WkbType wkbType() const /Deprecated/;
/** The wkb type.
@note Will be removed in 3.0 */
QgsWKBTypes::Type newWkbType() const;
//! @deprecated See setWkbType( QgsWKBTypes::Type )
void setWkbType( QGis::WkbType type ) /Deprecated/;
//! Sets the wkb type
void setWkbType( QgsWKBTypes::Type type );
//! Returns the srid
QString srid() const;
//! Sets the srid
void setSrid( const QString& srid );
};
|
