SqliteConnector.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
 
#include <OpenMS/KERNEL/StandardTypes.h>
#include <OpenMS/CONCEPT/Exception.h>
 
#include <string>
#include <vector>
 
namespace OpenMS
{
  namespace Internal
  {
    struct SqliteConnectorFriend;
  }
 
  class OPENMS_DLLAPI SqliteConnector
  {
  public:
 
    enum class SqlOpenMode
    {
      READ_ONLY,  
#ifndef READONLY
      READONLY = READ_ONLY, 
#endif
      READWRITE, 
      READWRITE_OR_CREATE 
    };
 
    SqliteConnector() = delete;
 
    explicit SqliteConnector(const std::string& filename, const SqlOpenMode mode = SqlOpenMode::READWRITE_OR_CREATE);
 
    ~SqliteConnector();
 
    bool tableExists(const std::string& tablename);
 
    Size countTableRows(const std::string& table_name);
 
    bool columnExists(const std::string& tablename, const std::string& colname);
 
    void executeStatement(const std::string& statement);
 
    void executeBindStatement(const std::string& prepare_statement, const std::vector<std::string>& data);
 
  protected:
 
    void openDatabase_(const std::string& filename, const SqlOpenMode mode);
 
    void* db_ = nullptr;
 
    friend struct Internal::SqliteConnectorFriend;
  };
 
} // namespace OpenMS