DBInitializerFromSQL.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - the GNU Lesser General Public License as published by               *
 *      the Free Software Foundation, either version 3 of the License,      *
 *      or (at your option) any later version,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
 *   FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,        *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR  *
 *   OTHER DEALINGS IN THE SOFTWARE.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2026                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/
 

#ifdef _ODBC
 
#  ifndef GUM_LEARNING_DB_INITIALIZER_FROM_SQL_H
#    define GUM_LEARNING_DB_INITIALIZER_FROM_SQL_H
 
#    include <agrum/agrum.h>
 
#    include <agrum/base/database/IDBInitializer.h>
#    include <agrum/base/database/nanodbcParser.h>
 
namespace gum {
 
  namespace learning {

    class GUM_SHARED_PUBLIC DBInitializerFromSQL: public IDBInitializer {
      public:
      // ##########################################################################
      // ##########################################################################


      DBInitializerFromSQL(const std::string& dataSource,
                           const std::string& login,
                           const std::string& password,
                           const std::string& query,
                           long               timeout = 0L);


      DBInitializerFromSQL(const std::string& connection_string,
                           const std::string& query,
                           long               timeout = 0L);


      DBInitializerFromSQL(const DBInitializerFromSQL& from);

      DBInitializerFromSQL(DBInitializerFromSQL&& from);

      [[nodiscard]] virtual DBInitializerFromSQL* clone() const;

      virtual ~DBInitializerFromSQL();

 
 
      // ##########################################################################
      // ##########################################################################



      DBInitializerFromSQL& operator=(const DBInitializerFromSQL& from);


      DBInitializerFromSQL& operator=(DBInitializerFromSQL&& from);

 
 
      protected:
      virtual std::vector< std::string > variableNames_() final;

      virtual const std::vector< std::string >& currentStringRow_() final;

      virtual bool nextRow_() final;
 
 
#    ifndef DOXYGEN_SHOULD_SKIP_THIS
 
      private:
      // the string specifying how to connect to the database
      std::string _connection_string_;
 
      // the current query
      std::string _query_;
 
      // the timeout for executing the queries
      long _timeout_;
 
      // the names of the columns in the query result
      std::vector< std::string > _var_names_;
 
      // the nanodbc connection to the database
      nanodbc::connection _connection_;
 
      // the parser used for parsing the query results
      NanodbcParser _parser_;

      void _connect_(const std::string& connection_string, long timeout);
 
 
#    endif /* DOXYGEN_SHOULD_SKIP_THIS */
    };
 
  } /* namespace learning */
 
} /* namespace gum */
 
// include the inlined functions if necessary
#    ifndef GUM_NO_INLINE
#      include <agrum/base/database/DBInitializerFromSQL_inl.h>
#    endif /* GUM_NO_INLINE */
 
#  endif   /* GUM_LEARNING_DB_INITIALIZER_FROM_SQL_H */
 
#endif     /* _ODBC */