SqliteConnector_impl.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Hannes Roest $
// $Authors: Hannes Roest $
// --------------------------------------------------------------------------
 
#pragma once
 
// -----------------------------------------------------------------------------
// PRIVATE (non-installed) implementation header.
//
// This header exposes the raw SQLite C API (sqlite3 / sqlite3_stmt) that backs
// OpenMS::SqliteConnector. It is deliberately NOT installed, NOT exported and
// NOT part of the public API, so that SQLite can remain a fully private link
// dependency of libOpenMS (no SQLite type ever appears in an installed header).
//
// It must only be included from .cpp files that live inside libOpenMS. Public
// (installed) headers must never include it.
// -----------------------------------------------------------------------------
 
#include <OpenMS/FORMAT/SqliteConnector.h>
#include <OpenMS/CONCEPT/Exception.h>
#include <OpenMS/DATASTRUCTURES/StringUtils.h>
 
#include <sqlite3.h>
 
#include <sstream>
#include <string>
#include <type_traits> // for is_same
#include <vector>
 
namespace OpenMS
{
  namespace Internal
  {
    struct SqliteConnectorFriend
    {
      static sqlite3* handle(SqliteConnector& conn)
      {
        return static_cast<sqlite3*>(conn.db_);
      }
    };
 
    namespace SqliteHelper
    {
      inline sqlite3* getNativeHandle(SqliteConnector& conn)
      {
        return SqliteConnectorFriend::handle(conn);
      }
 
      bool tableExists(sqlite3* db, const std::string& tablename);
 
      bool columnExists(sqlite3* db, const std::string& tablename, const std::string& colname);
 
      void executeStatement(sqlite3* db, const std::string& statement);
 
      void prepareStatement(sqlite3* db, sqlite3_stmt** stmt, const std::string& prepare_statement);
 
      inline void prepareStatement(SqliteConnector& conn, sqlite3_stmt** stmt, const std::string& prepare_statement)
      {
        prepareStatement(getNativeHandle(conn), stmt, prepare_statement);
      }
 
      void executeBindStatement(sqlite3* db, const std::string& prepare_statement, const std::vector<std::string>& data);
 
      template <typename T>
      UInt64 clearSignBit(T /*value*/)
      {
        static_assert(std::is_same<T, std::false_type>::value, "Wrong input type to clearSignBit(). Please pass unsigned 64bit ints!");
        return 0;
      };
      template <>
      inline UInt64 clearSignBit(UInt64 value) {
        return value & ~(1ULL << 63);
      }
 
 
      enum class SqlState
      {
        SQL_ROW,
        SQL_DONE,
        SQL_ERROR 
      };
 
      SqlState nextRow(sqlite3_stmt* stmt, SqlState current = SqlState::SQL_ROW);
 
 
      template <typename ValueType>
      bool extractValue(ValueType* /* dst */, sqlite3_stmt* /* stmt */, int /* pos */)
      {
        throw Exception::IllegalArgument(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION,
          "Not implemented");
      }
 
      template <> bool extractValue<double>(double* dst, sqlite3_stmt* stmt, int pos); //explicit specialization
 
      template <> bool extractValue<int>(int* dst, sqlite3_stmt* stmt, int pos); //explicit specialization
      template <> bool extractValue<Int64>(Int64* dst, sqlite3_stmt* stmt, int pos); //explicit specialization
 
      template <> bool extractValue<std::string>(std::string* dst, sqlite3_stmt* stmt, int pos); //explicit specialization
 
      bool extractValueIntStr(std::string* dst, sqlite3_stmt* stmt, int pos);
 
      double extractDouble(sqlite3_stmt* stmt, int pos);
      float extractFloat(sqlite3_stmt* stmt, int pos); 
      int extractInt(sqlite3_stmt* stmt, int pos);
      Int64 extractInt64(sqlite3_stmt* stmt, int pos);
      std::string extractString(sqlite3_stmt* stmt, int pos);
      char extractChar(sqlite3_stmt* stmt, int pos);
      bool extractBool(sqlite3_stmt* stmt, int pos);
    }
  }
} // namespace OpenMS