SqliteConnector.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2023.
//
// This software is released under a three-clause BSD license:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $Maintainer: Hannes Roest $
// $Authors: Hannes Roest $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/KERNEL/StandardTypes.h>
#include <OpenMS/DATASTRUCTURES/String.h>
#include <OpenMS/CONCEPT/Exception.h>
 
#include <type_traits> // for is_same
 
// forward declarations
struct sqlite3;
struct sqlite3_stmt;
 
namespace OpenMS
{
  class OPENMS_DLLAPI SqliteConnector
  {
  public:
 
    enum class SqlOpenMode
    {
      READONLY,  
      READWRITE, 
      READWRITE_OR_CREATE 
    };
 
    SqliteConnector() = delete;
 
    explicit SqliteConnector(const String& filename, const SqlOpenMode mode = SqlOpenMode::READWRITE_OR_CREATE);
 
    ~SqliteConnector();
 
    sqlite3* getDB()
    {
      return db_;
    }
 
    bool tableExists(const String& tablename)
    {
      return tableExists(db_, tablename);
    }
 
    Size countTableRows(const String& table_name);
 
    bool columnExists(const String& tablename, const String& colname)
    {
      return columnExists(db_, tablename, colname);
    }
 
    void executeStatement(const String& statement)
    {
      executeStatement(db_, statement);
    }
 
    void executeBindStatement(const String& prepare_statement, const std::vector<String>& data)
    {
      executeBindStatement(db_, prepare_statement, data);
    }
 
    void prepareStatement(sqlite3_stmt** stmt, const String& prepare_statement)
    {
      prepareStatement(db_, stmt, prepare_statement);
    }
 
    static bool tableExists(sqlite3* db, const String& tablename);
 
    static bool columnExists(sqlite3* db, const String& tablename, const String& colname);
 
    static void executeStatement(sqlite3* db, const std::stringstream& statement);
 
    static void executeStatement(sqlite3* db, const String& statement);
 
    static void prepareStatement(sqlite3* db, sqlite3_stmt** stmt, const String& prepare_statement);
 
 
    static void executeBindStatement(sqlite3* db, const String& prepare_statement, const std::vector<String>& data);
 
  protected:
 
    void openDatabase_(const String& filename, const SqlOpenMode mode);
 
  protected:
    sqlite3* db_ = nullptr;
 
  };
 
  namespace Internal
  {
    namespace SqliteHelper
    {
      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<String>(String* 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(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);
      String extractString(sqlite3_stmt* stmt, int pos);
      char extractChar(sqlite3_stmt* stmt, int pos);
      bool extractBool(sqlite3_stmt* stmt, int pos); // end of sqlThrowingGetters
    }
  }
 
 
} // namespace OpenMS