DatabaseInterface.h

Go to the documentation of this file.

// Copyright CERN and copyright holders of ALICE O2. This software is
// distributed under the terms of the GNU General Public License v3 (GPL
// Version 3), copied verbatim in the file "COPYING".
//
// See http://alice-o2.web.cern.ch/license for full licensing information.
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.


#ifndef QC_REPOSITORY_DATABASEINTERFACE_H
#define QC_REPOSITORY_DATABASEINTERFACE_H

#include <string>
#include <memory>
#include <vector>
#include <unordered_map>

#include <Framework/ServiceRegistry.h>

#include "QualityControl/QualityObject.h"
#include "QualityControl/MonitorObject.h"

namespace o2::quality_control::repository
{

class DatabaseInterface
{
 public:
  constexpr static framework::ServiceKind service_kind = framework::ServiceKind::Global;

  DatabaseInterface() = default;
  virtual ~DatabaseInterface() = default;

  virtual void connect(std::string host, std::string database, std::string username, std::string password) = 0;
  virtual void connect(const std::unordered_map<std::string, std::string>& config) = 0;

  virtual void storeMO(std::shared_ptr<const o2::quality_control::core::MonitorObject> mo, long from = -1, long to = -1) = 0;

  virtual void storeQO(std::shared_ptr<const o2::quality_control::core::QualityObject> qo, long from = -1, long to = -1) = 0;

  virtual std::shared_ptr<o2::quality_control::core::MonitorObject> retrieveMO(std::string taskName, std::string objectName, long timestamp = -1) = 0;
  virtual std::shared_ptr<o2::quality_control::core::QualityObject> retrieveQO(std::string qoPath, long timestamp = -1) = 0;
  virtual TObject* retrieveTObject(std::string path, const std::map<std::string, std::string>& metadata, long timestamp = -1, std::map<std::string, std::string>* headers = nullptr) = 0;

  virtual std::string retrieveMOJson(std::string taskName, std::string objectName, long timestamp = -1) = 0;
  virtual std::string retrieveQOJson(std::string qoPath, long timestamp = -1) = 0;
  virtual std::string retrieveJson(std::string path, long timestamp, const std::map<std::string, std::string>& metadata) = 0;
  virtual std::string retrieveJson(std::string path)
  {
    std::map<std::string, std::string> metadata;
    return retrieveJson(path, -1, metadata);
  }

  virtual void disconnect() = 0;
  virtual void prepareTaskDataContainer(std::string taskName) = 0;
  virtual std::vector<std::string> getPublishedObjectNames(std::string taskName) = 0;
  virtual void truncate(std::string taskName, std::string objectName) = 0;
};

} // namespace o2::quality_control::repository

#endif /* QC_REPOSITORY_DATABASEINTERFACE_H */