/usr/include/qgis/qgsdatasourceuri.h is in libqgis-dev 2.8.6+dfsg-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /***************************************************************************
qgsdatasourceuri.h - Structure to contain the component parts
of a data source URI
-------------------
begin : Dec 5, 2004
copyright : (C) 2004 by Gary E.Sherman
email : sherman at mrcc.com
***************************************************************************/
/***************************************************************************
* *
* 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 QGSDATASOURCEURI_H
#define QGSDATASOURCEURI_H
#include "qgis.h"
#include <QMap>
/** \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 CORE_EXPORT QgsDataSourceURI
{
public:
enum SSLmode { SSLprefer, SSLdisable, SSLallow, SSLrequire };
//! default constructor
QgsDataSourceURI();
//! constructor which parses input URI
QgsDataSourceURI( QString uri );
//! constructor which parses input encoded URI (generic mode)
QgsDataSourceURI( const QByteArray & uri );
//! return connection part of URI
QString connectionInfo() const;
//! return complete uri
QString uri() 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 );
void setParam( const QString &key, const QStringList &value );
//! 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 );
//! 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 );
//! 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 username
void setUsername( QString username );
//! set password
void setPassword( QString password );
//! Removes password element from uris
static QString removePassword( const QString& aUri );
QString username() const;
QString schema() const;
QString table() const;
QString sql() const;
QString geometryColumn() const;
//! set use Estimated Metadata
void setUseEstimatedMetadata( bool theFlag );
bool useEstimatedMetadata() const;
void disableSelectAtId( bool theFlag );
bool selectAtIdDisabled() 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 );
QGis::WkbType wkbType() const;
void setWkbType( QGis::WkbType type );
QString srid() const;
void setSrid( QString srid );
private:
void skipBlanks( const QString &uri, int &i );
QString getValue( const QString &uri, int &i );
QString escape( const QString &uri, QChar delim ) const;
/* data */
//! host name
QString mHost;
//! port the database server listens on
QString mPort;
//! service name
QString mService;
//! database name
QString mDatabase;
//! schema
QString mSchema;
//! spatial table
QString mTable;
//! geometry column
QString mGeometryColumn;
//! SQL query or where clause used to limit features returned from the layer
QString mSql;
//! username
QString mUsername;
//! password
QString mPassword;
//! ssl mode
enum SSLmode mSSLmode;
//! key column
QString mKeyColumn;
//! Use estimated metadata flag
bool mUseEstimatedMetadata;
//! Disable SelectAtId capability (eg. to trigger the attribute table memory model for expensive views)
bool mSelectAtIdDisabled;
//! geometry type (or QGis::WKBUnknown if not specified)
QGis::WkbType mWkbType;
//! SRID or a null string if not specified
QString mSrid;
//! Generic params store
QMap<QString, QString> mParams;
};
#endif //QGSDATASOURCEURI_H
|