/
qgspostgresconn.h
465 lines (368 loc) · 14.2 KB
/
qgspostgresconn.h
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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
/***************************************************************************
qgspostgresconn.h - connection class to PostgreSQL/PostGIS
-------------------
begin : 2011/01/28
copyright : (C) 2011 by Juergen E. Fischer
email : jef at norbit dot de
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef QGSPOSTGRESCONN_H
#define QGSPOSTGRESCONN_H
#include <QString>
#include <QStringList>
#include <QVector>
#include <QMap>
#include <QMutex>
#include "qgis.h"
#include "qgsdatasourceuri.h"
#include "qgswkbtypes.h"
#include "qgsconfig.h"
extern "C"
{
#include <libpq-fe.h>
}
class QgsField;
//! Spatial column types
enum QgsPostgresGeometryColumnType
{
SctNone,
SctGeometry,
SctGeography,
SctTopoGeometry,
SctPcPatch,
SctRaster
};
enum QgsPostgresPrimaryKeyType
{
PktUnknown,
PktInt,
PktInt64,
PktUint64,
PktTid,
PktOid,
PktFidMap
};
//! Schema properties structure
struct QgsPostgresSchemaProperty
{
QString name;
QString description;
QString owner;
};
//! Layer Property structure
// TODO: Fill to Postgres/PostGIS specifications
struct QgsPostgresLayerProperty
{
// Postgres/PostGIS layer properties
QList<QgsWkbTypes::Type> types;
QString schemaName;
QString tableName;
QString geometryColName;
QgsPostgresGeometryColumnType geometryColType;
QStringList pkCols;
QList<int> srids;
unsigned int nSpCols;
QString sql;
QString relKind;
bool isView = false;
bool isMaterializedView = false;
bool isForeignTable = false;
bool isRaster = false;
QString tableComment;
// TODO: rename this !
int size() const { Q_ASSERT( types.size() == srids.size() ); return types.size(); }
QString defaultName() const
{
QString n = tableName;
if ( nSpCols > 1 ) n += '.' + geometryColName;
return n;
}
QgsPostgresLayerProperty at( int i ) const
{
QgsPostgresLayerProperty property;
Q_ASSERT( i >= 0 && i < size() );
property.types << types[ i ];
property.srids << srids[ i ];
property.schemaName = schemaName;
property.tableName = tableName;
property.geometryColName = geometryColName;
property.geometryColType = geometryColType;
property.pkCols = pkCols;
property.nSpCols = nSpCols;
property.sql = sql;
property.relKind = relKind;
property.isView = isView;
property.isRaster = isRaster;
property.isMaterializedView = isMaterializedView;
property.tableComment = tableComment;
return property;
}
#ifdef QGISDEBUG
QString toString() const
{
QString typeString;
const auto constTypes = types;
for ( QgsWkbTypes::Type type : constTypes )
{
if ( !typeString.isEmpty() )
typeString += '|';
typeString += QString::number( type );
}
QString sridString;
const auto constSrids = srids;
for ( int srid : constSrids )
{
if ( !sridString.isEmpty() )
sridString += '|';
sridString += QString::number( srid );
}
return QStringLiteral( "%1.%2.%3 type=%4 srid=%5 pkCols=%6 sql=%7 nSpCols=%8" )
.arg( schemaName,
tableName,
geometryColName,
typeString,
sridString,
pkCols.join( QStringLiteral( "|" ) ),
sql )
.arg( nSpCols );
}
#endif
};
class QgsPostgresResult
{
public:
explicit QgsPostgresResult( PGresult *result = nullptr ) : mRes( result ) {}
~QgsPostgresResult();
QgsPostgresResult &operator=( PGresult *result );
QgsPostgresResult &operator=( const QgsPostgresResult &src );
QgsPostgresResult( const QgsPostgresResult &rh ) = delete;
ExecStatusType PQresultStatus();
QString PQresultErrorMessage();
int PQntuples();
QString PQgetvalue( int row, int col );
bool PQgetisnull( int row, int col );
int PQnfields();
QString PQfname( int col );
Oid PQftable( int col );
Oid PQftype( int col );
int PQfmod( int col );
int PQftablecol( int col );
Oid PQoidValue();
PGresult *result() const { return mRes; }
private:
PGresult *mRes = nullptr;
};
class QgsPostgresConn : public QObject
{
Q_OBJECT
public:
/*
* \param shared allow using a shared connection. Should never be
* called from a thread other than the main one.
* An assertion guards against such programmatic error.
*/
static QgsPostgresConn *connectDb( const QString &connInfo, bool readOnly, bool shared = true, bool transaction = false );
void ref();
void unref();
//! Gets postgis version string
QString postgisVersion() const;
//! Gets status of GEOS capability
bool hasGEOS() const;
//! Gets status of topology capability
bool hasTopology() const;
//! Gets status of Pointcloud capability
bool hasPointcloud() const;
//! Gets status of Raster capability
bool hasRaster() const;
//! encode wkb in hex
bool useWkbHex() const { return mUseWkbHex; }
//! major PostGIS version
int majorVersion() const { return mPostgisVersionMajor; }
//! minor PostGIS version
int minorVersion() const { return mPostgisVersionMinor; }
//! PostgreSQL version
int pgVersion() const { return mPostgresqlVersion; }
//! run a query and free result buffer
bool PQexecNR( const QString &query );
//! cursor handling
bool openCursor( const QString &cursorName, const QString &declare );
bool closeCursor( const QString &cursorName );
QString uniqueCursorName();
#if 0
PGconn *pgConnection() { return mConn; }
#endif
//
// libpq wrapper
//
// run a query and check for errors, thread-safe
PGresult *PQexec( const QString &query, bool logError = true, bool retry = true ) const;
void PQfinish();
QString PQerrorMessage() const;
int PQstatus() const;
PGresult *PQprepare( const QString &stmtName, const QString &query, int nParams, const Oid *paramTypes );
PGresult *PQexecPrepared( const QString &stmtName, const QStringList ¶ms );
/**
* PQsendQuery is used for asynchronous queries (with PQgetResult)
* Thread safety must be ensured by the caller by calling QgsPostgresConn::lock() and QgsPostgresConn::unlock()
*/
int PQsendQuery( const QString &query );
/**
* PQgetResult is used for asynchronous queries (with PQsendQuery)
* Thread safety must be ensured by the caller by calling QgsPostgresConn::lock() and QgsPostgresConn::unlock()
*/
PGresult *PQgetResult();
bool begin();
bool commit();
bool rollback();
// cancel running query
bool cancel();
/**
* Double quote a PostgreSQL identifier for placement in a SQL string.
*/
static QString quotedIdentifier( const QString &ident );
/**
* Quote a value for placement in a SQL string.
*/
static QString quotedValue( const QVariant &value );
/**
* Quote a json(b) value for placement in a SQL string.
* \note a null value will be represented as a NULL and not as a json null.
*/
static QString quotedJsonValue( const QVariant &value );
/**
* Gets the list of supported layers
* \param layers list to store layers in
* \param searchGeometryColumnsOnly only look for geometry columns which are
* contained in the geometry_columns metatable
* \param searchPublicOnly
* \param allowGeometrylessTables
* \param schema restrict layers to layers within specified schema
* \returns true if layers were fetched successfully
*/
bool supportedLayers( QVector<QgsPostgresLayerProperty> &layers,
bool searchGeometryColumnsOnly = true,
bool searchPublicOnly = true,
bool allowGeometrylessTables = false,
const QString &schema = QString() );
/**
* Gets the list of database schemas
* \param schemas list to store schemas in
* \returns true if schemas where fetched successfully
* \since QGIS 2.7
*/
bool getSchemas( QList<QgsPostgresSchemaProperty> &schemas );
/**
* Determine type and srid of a layer from data (possibly estimated)
*/
void retrieveLayerTypes( QgsPostgresLayerProperty &layerProperty, bool useEstimatedMetadata );
/**
* Determine type and srid of a vector of layers from data (possibly estimated)
*/
void retrieveLayerTypes( QVector<QgsPostgresLayerProperty *> &layerProperties, bool useEstimatedMetadata );
/**
* Gets information about the spatial tables
* \param searchGeometryColumnsOnly only look for geometry columns which are
* contained in the geometry_columns metatable
* \param searchPublicOnly
* \param allowGeometrylessTables
* \param schema restrict tables to those within specified schema
* \returns true if tables were successfully queried
*/
bool getTableInfo( bool searchGeometryColumnsOnly, bool searchPublicOnly, bool allowGeometrylessTables,
const QString &schema = QString() );
qint64 getBinaryInt( QgsPostgresResult &queryResult, int row, int col );
QString fieldExpressionForWhereClause( const QgsField &fld, QVariant::Type valueType = QVariant::LastType, QString expr = "%1" );
QString fieldExpression( const QgsField &fld, QString expr = "%1" );
QString connInfo() const { return mConnInfo; }
/**
* Returns the underlying database.
*
* \since QGIS 3.0
*/
QString currentDatabase() const;
static const int GEOM_TYPE_SELECT_LIMIT;
static QString displayStringForWkbType( QgsWkbTypes::Type wkbType );
static QString displayStringForGeomType( QgsPostgresGeometryColumnType geomType );
static QgsWkbTypes::Type wkbTypeFromPostgis( const QString &dbType );
static QString postgisWkbTypeName( QgsWkbTypes::Type wkbType );
static int postgisWkbTypeDim( QgsWkbTypes::Type wkbType );
static void postgisWkbType( QgsWkbTypes::Type wkbType, QString &geometryType, int &dim );
static QString postgisTypeFilter( QString geomCol, QgsWkbTypes::Type wkbType, bool castToGeometry );
static QgsWkbTypes::Type wkbTypeFromGeomType( QgsWkbTypes::GeometryType geomType );
static QgsWkbTypes::Type wkbTypeFromOgcWkbType( unsigned int ogcWkbType );
static QStringList connectionList();
static QString selectedConnection();
static void setSelectedConnection( const QString &connName );
static QgsDataSourceUri connUri( const QString &connName );
static bool publicSchemaOnly( const QString &connName );
static bool geometryColumnsOnly( const QString &connName );
static bool dontResolveType( const QString &connName );
static bool useEstimatedMetadata( const QString &connName );
static bool allowGeometrylessTables( const QString &connName );
static bool allowProjectsInDatabase( const QString &connName );
static void deleteConnection( const QString &connName );
//! A connection needs to be locked when it uses transactions, see QgsPostgresConn::{begin,commit,rollback}
void lock() { mLock.lock(); }
void unlock() { mLock.unlock(); }
private:
QgsPostgresConn( const QString &conninfo, bool readOnly, bool shared, bool transaction );
~QgsPostgresConn() override;
int mRef;
int mOpenCursors;
PGconn *mConn = nullptr;
QString mConnInfo;
//! GEOS capability
mutable bool mGeosAvailable;
//! PROJ capability
mutable bool mProjAvailable;
//! Topology capability
mutable bool mTopologyAvailable;
//! PostGIS version string
mutable QString mPostgisVersionInfo;
//! Are mPostgisVersionMajor, mPostgisVersionMinor, mGeosAvailable, mTopologyAvailable valid?
mutable bool mGotPostgisVersion;
//! PostgreSQL version
mutable int mPostgresqlVersion;
//! PostGIS major version
mutable int mPostgisVersionMajor;
//! PostGIS minor version
mutable int mPostgisVersionMinor;
//! pointcloud support available
mutable bool mPointcloudAvailable;
//! raster support available
mutable bool mRasterAvailable;
//! encode wkb in hex
mutable bool mUseWkbHex;
bool mReadOnly;
QStringList supportedSpatialTypes() const;
static QMap<QString, QgsPostgresConn *> sConnectionsRW;
static QMap<QString, QgsPostgresConn *> sConnectionsRO;
//! Count number of spatial columns in a given relation
void addColumnInfo( QgsPostgresLayerProperty &layerProperty, const QString &schemaName, const QString &viewName, bool fetchPkCandidates );
//! List of the supported layers
QVector<QgsPostgresLayerProperty> mLayersSupported;
/**
* Flag indicating whether data from binary cursors must undergo an
* endian conversion prior to use
\note
XXX Umm, it'd be helpful to know what we're swapping from and to.
XXX Presumably this means swapping from big-endian (network) byte order
XXX to little-endian; but the inverse transaction is possible, too, and
XXX that's not reflected in this variable
*/
bool mSwapEndian;
void deduceEndian();
int mNextCursorId;
bool mShared; //!< Whether the connection is shared by more providers (must not be if going to be used in worker threads)
bool mTransaction;
mutable QMutex mLock;
};
// clazy:excludeall=qstring-allocations
#endif