ODBC.h

/*
 * Copyright(c) Sophist Solutions, Inc. 1990-2025.  All rights reserved
 */
#ifndef _Stroika_Foundation_Database_SQL_ODBCClient_h_
#define _Stroika_Foundation_Database_SQL_ODBCClient_h_ 1
 
#include "Stroika/Foundation/StroikaPreComp.h"
 
#include "Stroika/Foundation/Database/SQL/Connection.h"
#include "Stroika/Foundation/Database/SQL/Statement.h"
#include "Stroika/Foundation/Database/SQL/Transaction.h"
 
/*
 *  \file
 *
 *  \note Code-Status:  <a href="Code-Status.md#Alpha">Alpha</a>
 *
 * TODO:
 *      @todo   ADD Sample/Regression test support for this
 *              make sure working UNIX/Windows
 *              see also maybe http://www.unixodbc.org/
 *      @todo   Largely NYI (need statement code to do much of anything)
 *      @todo   Perhaps add functionality to read back table structure (schema) from the database
 *
 */
 
/*
@CONFIGVAR:     qStroika_HasComponent_ODBC
@DESCRIPTION:   <p>Defines if Stroika is built supporting ODBC (only do if ODBC headers in -I path)/p>
*/
#ifndef qStroika_HasComponent_ODBC
#error "qStroika_HasComponent_ODBC should normally be defined indirectly by StroikaConfig.h"
#endif
 
namespace Stroika::Foundation::Database::SQL::ODBC {
 
    using namespace std;
 
#if qStroika_HasComponent_ODBC
 
    namespace Connection {
 
        using namespace SQL::Connection;
 
        class IRep;
 
        /**
         *  These are options used to create a database Connection::Ptr object (with Connection::New).
         *
         *  Since this is also how you create a database, in a sense, its those options too.
         */
        struct Options final {
            /**
             */
            optional<String> fDSN;
        };
 
        /**
         *  Connection provides an API for accessing an ODBC database.
         *
         *  A new Connection::Ptr is typically created ODBC::Connection::New()
         */
        class Ptr : public SQL::Connection::Ptr {
        private:
            using inherited = SQL::Connection::Ptr;
 
        public:
            /**
             */
            Ptr (const Ptr& src);
            Ptr (const shared_ptr<IRep>& src = nullptr);
 
        public:
            ~Ptr () = default;
 
        public:
            /**
             */
            nonvirtual Ptr& operator= (const Ptr& src);
            nonvirtual Ptr& operator= (Ptr&& src) noexcept;
 
        public:
            /**
         */
            nonvirtual IRep* operator->() const noexcept;
 
        private:
            friend class Statement;
        };
 
        /**
         *  The dbInitializer is called IFF the New () call results in a newly created database (@todo RECONSIDER).
         */
        Ptr New (const Options& options);
 
        /**
         *  Connection provides an API for accessing an ODBC database.
         * 
         *  Typically don't use this directly, but use Connecion::Ptr, a smart ptr wrapper on this interface.
         */
        class IRep : public SQL::Connection::IRep {
        public:
            [[no_unique_address]] Debug::AssertExternallySynchronizedMutex fAssertExternallySynchronizedMutex;
 
        private:
            friend class Ptr;
        };
 
    };
 
    class Statement;
 
    /**
     */
    class Statement : public SQL::Statement {
    private:
        using inherited = SQL::Statement;
 
    public:
        /**
         */
        Statement () = delete;
        Statement (const Connection::Ptr& db, const String& query);
        Statement (const Statement&) = delete;
 
    private:
        struct MyRep_;
    };
 
    /**
     */
    class Transaction : public SQL::Transaction {
    private:
        using inherited = SQL::Transaction;
 
    public:
        /**
         */
        Transaction () = delete;
        Transaction (const Connection::Ptr& db);
        Transaction (const Transaction&) = delete;
 
    private:
        struct MyRep_;
    };
#endif
 
}
 
/*
 ********************************************************************************
 ***************************** Implementation Details ***************************
 ********************************************************************************
 */
#include "ODBC.inl"
 
#endif /*_Stroika_Foundation_Database_SQL_ODBCClient_h_*/