DBConnection.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-2012.
//
// 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: $
// $Authors: Marc Sturm $
// --------------------------------------------------------------------------

#ifndef OPENMS_FORMAT_DB_DBCONNECTION_H
#define OPENMS_FORMAT_DB_DBCONNECTION_H

#include <OpenMS/config.h>

//QT includes
#include <QtSql/QSqlDatabase>
#include <QtSql/QSqlQuery>

//OpenMS includes
#include <OpenMS/CONCEPT/Exception.h>
#include <OpenMS/DATASTRUCTURES/String.h>
#include <OpenMS/CONCEPT/Types.h>

#include <iostream>

namespace OpenMS
{
  class OPENMS_DLLAPI DBConnection
  {
public:
    class OPENMS_DLLAPI InvalidQuery :
      public Exception::BaseException
    {
public:
      InvalidQuery(const char * file, Int line, const char * function, const String & sql_query, const String & sql_error);
      ~InvalidQuery() throw();
    };

    class OPENMS_DLLAPI NotConnected :
      public Exception::BaseException
    {
public:
      NotConnected(const char * file, Int line, const char * function);
      ~NotConnected() throw();
    };



    DBConnection();

    ~DBConnection();

    void connect(const String & db, const String & user, const String & password, const String & host = "localhost", UInt port = 3306, const String & QTDBDriver = DB_PLUGIN, const String & connection_name = "OpenMS_default_connection");

    bool isConnected() const;

    void disconnect();

    QSqlQuery executeQuery(const String & query, bool first = false);

    Int getIntValue(const String & table, const String & column, const String & id);

    double getDoubleValue(const String & table, const String & column, const String & id);

    String getStringValue(const String & table, const String & column, const String & id);

    UInt getId(const String & table, const String & column, const String & value);

    UInt getAutoId();

    String DBName() const;

    void render(QSqlQuery & result, std::ostream & out = std::cout, const String & separator = " | ", const String & line_begin = "", const String & line_end = "\n");


    template <class StringListType>
    void executeQueries(const StringListType & queries);

private:

    QString connection_name_;

    inline QSqlDatabase getDB_() const
    {
      return QSqlDatabase::database(connection_name_, false);
    }

  };



  //---------------------------------------------------------------
  //  Implementation of the inline / template functions
  //---------------------------------------------------------------

  template <class StringListType>
  void DBConnection::executeQueries(const StringListType & queries)
  {
    String line;
    for (typename StringListType::const_iterator it = queries.begin(); it != queries.end(); ++it)
    {
      line = *it;
      line.trim();
      if (line != "")
      {
        executeQuery(line);
      }
    }
  }

}

#endif