File indexing completed on 2024-05-05 16:47:14

 /* This file is part of the KDE project
    Copyright (C) 2003 Adam Pigg <adam@piggz.co.uk>
    Copyright (C) 2010-2016 Jarosław Staniek <staniek@kde.org>
 
    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.
 
    You should have received a copy of the GNU Library General Public License
    along with this program; see the file COPYING.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  * Boston, MA 02110-1301, USA.
 */
 
 #ifndef KDB_POSTGRESQLCONNECTION_H
 #define KDB_POSTGRESQLCONNECTION_H
 
 #include "KDbConnection.h"
 #include "KDbTransactionData.h"
 
 #include <libpq-fe.h>
 
 class PostgresqlConnectionInternal;
 
 //! @internal
 class PostgresqlTransactionData : public KDbTransactionData
 {
 public:
     explicit PostgresqlTransactionData(KDbConnection *conn);
     ~PostgresqlTransactionData();
 private:
     Q_DISABLE_COPY(PostgresqlTransactionData)
 };
 
 class PostgresqlConnection : public KDbConnection
 {
     Q_DECLARE_TR_FUNCTIONS(PostgresqlConnection)
 public:
     ~PostgresqlConnection() override;
 
     //! @return a new query based on a query statement
     Q_REQUIRED_RESULT KDbCursor *prepareQuery(const KDbEscapedString &sql,
                                               KDbCursor::Options options
                                               = KDbCursor::Option::None) override;
 
     //! @return a new query based on a query object
     Q_REQUIRED_RESULT KDbCursor *prepareQuery(KDbQuerySchema *query,
                                               KDbCursor::Options options
                                               = KDbCursor::Option::None) override;
 
     Q_REQUIRED_RESULT KDbPreparedStatementInterface *prepareStatementInternal() override;
 
     /*! Connection-specific string escaping.  */
     KDbEscapedString escapeString(const QString& str) const override;
     virtual KDbEscapedString escapeString(const QByteArray& str) const;
 
 private:
     /*! Used by driver */
     PostgresqlConnection(KDbDriver *driver, const KDbConnectionData& connData,
                          const KDbConnectionOptions &options);
 
     //! @return true if currently connected to a database, ignoring the m_is_connected flag.
     bool drv_isDatabaseUsed() const override;
     //! Noop: we tell we are connected, but we wont actually connect until we use a database.
     bool drv_connect() override;
     bool drv_getServerVersion(KDbServerVersionInfo* version) override;
     //! Noop: we tell we have disconnected, but it is actually handled by closeDatabase.
     bool drv_disconnect() override;
     //! @return a list of database names
     bool drv_getDatabasesList(QStringList* list) override;
     //! Create a new database
     bool drv_createDatabase(const QString &dbName = QString()) override;
     //! Uses database. Note that if data().localSocketFileName() is not empty,
     //! only directory path is used for connecting; the local socket's filename stays ".s.PGSQL.5432".
     bool drv_useDatabase(const QString &dbName = QString(), bool *cancelled = nullptr,
                                  KDbMessageHandler* msgHandler = nullptr) override;
     //! Close the database connection
     bool drv_closeDatabase() override;
     //! Drops the given database
     bool drv_dropDatabase(const QString &dbName = QString()) override;
     //! Executes an SQL statement
     Q_REQUIRED_RESULT KDbSqlResult *drv_prepareSql(const KDbEscapedString &sql) override;
     bool drv_executeSql(const KDbEscapedString& sql) override;
 
     //! Implemented for KDbResultable
     QString serverResultName() const override;
 
 //! @todo move this somewhere to low level class (MIGRATION?)
     tristate drv_containsTable(const QString &tableName) override;
 
     void storeResult(PGresult *pgResult, ExecStatusType execStatus);
 
     PostgresqlConnectionInternal * const d;
 
     friend class PostgresqlDriver;
     friend class PostgresqlCursorData;
     friend class PostgresqlTransactionData;
     friend class PostgresqlSqlResult;
     Q_DISABLE_COPY(PostgresqlConnection)
 };
 
 #endif