ODBCConnection.h

/*
╔══════════════════════════════════════════════════════════════════════════════╗
║                        SIMPLY POWERFUL TOOLKIT (SPTK)                        ║
╟──────────────────────────────────────────────────────────────────────────────╢
║  copyright            © 1999-2022 Alexey Parshin. All rights reserved.       ║
║  email                alexeyp@gmail.com                                      ║
╚══════════════════════════════════════════════════════════════════════════════╝
┌──────────────────────────────────────────────────────────────────────────────┐
│   This library 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 library 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 library; if not, write to the Free Software Foundation,    │
│   Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.               │
│                                                                              │
│   Please report all bugs and problems to alexeyp@gmail.com.                  │
└──────────────────────────────────────────────────────────────────────────────┘
*/
 
#pragma once
 
#include <sptk5/sptk.h>
 
#ifdef HAVE_ODBC
 
#include <array>
#include <sptk5/db/DatabaseField.h>
#include <sptk5/db/ODBCEnvironment.h>
#include <sptk5/db/PoolDatabaseConnection.h>
 
namespace sptk {
 
class SP_DRIVER_EXPORT ODBCConnection
    : public PoolDatabaseConnection
{
    friend class Query;
 
public:
    explicit ODBCConnection(const String& connectionString = "", std::chrono::seconds connectTimeout = std::chrono::seconds(60));
 
    ODBCConnection(const ODBCConnection&) = delete;
 
    ODBCConnection(ODBCConnection&&) noexcept = default;
 
    ~ODBCConnection() override
    {
        close();
    }
 
    ODBCConnection& operator=(const ODBCConnection&) = delete;
 
    ODBCConnection& operator=(ODBCConnection&&) noexcept = default;
 
    String nativeConnectionString() const override;
 
    void closeDatabase() override;
 
    bool active() const override;
 
    DBHandle handle() const override;
 
    String driverDescription() const override;
 
    void objectList(DatabaseObjectType objectType, Strings& objects) override;
 
    static std::map<ODBCConnection*, std::shared_ptr<ODBCConnection>> s_odbcConnections;
 
protected:
    void driverBeginTransaction() override;
 
    void driverEndTransaction(bool commit) override;
 
    // These methods implement the actions requested by CQuery
    String queryError(const Query* query) const override;
 
    void queryAllocStmt(Query* query) override;
 
    void queryFreeStmt(Query* query) override;
 
    void queryCloseStmt(Query* query) override;
 
    void queryPrepare(Query* query) override;
 
    void queryExecute(Query* query) override;
 
    int queryColCount(Query* query) override;
 
    void queryColAttributes(Query* query, int16_t column, int16_t descType, int32_t& value) override;
 
    void queryColAttributes(Query* query, int16_t column, int16_t descType, char* buff, int len) override;
 
    void queryBindParameters(Query* query) override;
 
    void queryOpen(Query* query) override;
 
    void queryFetch(Query* query) override;
 
    static void ODBCtypeToCType(int odbcType, int32_t& ctype, VariantDataType& dataType);
 
    ODBCConnectionBase* connection()
    {
        return m_connect.get();
    }
 
    static void listDataSources(Strings& dsns);
 
    void _openDatabase(const String& connectionString) override;
 
    void _executeBatchSQL(const sptk::Strings& batchSQL, Strings* errors) override;
 
    void _bulkInsert(const String& tableName, const Strings& columnNames,
                     const std::vector<VariantVector>& data) override;
 
private:
    static constexpr size_t MAX_NAME_LEN = 256;
 
    std::shared_ptr<ODBCConnectionBase> m_connect {std::make_shared<ODBCConnectionBase>()};
 
    String queryError(SQLHSTMT stmt) const;
 
    void parseColumns(Query* query, int count);
 
    SQLHSTMT makeObjectListStatement(const DatabaseObjectType& objectType, sptk::Buffer& objectSchema, sptk::Buffer& objectName, short& procedureType) const;
};
} // namespace sptk
#endif
 
extern "C" {
SP_DRIVER_EXPORT [[maybe_unused]] void* odbc_create_connection(const char* connectionString, size_t connectionTimeoutSeconds);
SP_DRIVER_EXPORT [[maybe_unused]] void odbc_destroy_connection(void* connection);
}