CcdbDatabase.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_CCDBDATABASE_H
#define QC_REPOSITORY_CCDBDATABASE_H

#include <CCDB/CcdbApi.h>

#include "QualityControl/DatabaseInterface.h"

namespace o2::quality_control::repository
{

/*
 * Notes (also concerning the underlying CcdbApi)
 * - having 1 file per object per version server-side might lead to a tremendous number of files.
 *    --> they are aware of it
 * - how to add a new filter ? such as expert/shifter flag
 *    --> new metadata
 * - what are those time intervals ? what does it mean for us ?
 *    --> epoch milliseconds as long values
 * - how to know the real time at which the object was stored ?
 *    --> new api should allow for it. To be confirmed.
 * - we rather have a task_name/X/Y/Z/object_name/.../time where X/Y/Z are actually part of object_name but happen to
 * have slashes, to build a hierarchy of objects
 *    --> we can.
 * - we need to have a way to query for all objects in a certain path, e.g. in "task_name/X/Y" or in "task_name"
 *    --> the new api should allow it. To be tested.
 * - when retrieving an object, despite what the usage menu says, the time can't be omitted.
 *    --> doc has been udpated.
 * - initial tests show that it seems pretty slow.
 *    --> ok on their server with the new metadata database (postgresql)
 * - Current path to objects : .../task/object with object possibly a slash separated subpath (up to 6 levels). Also
 * consider having a task name such as "TPC/Task1" such as to build a tree of tasks with subsystems prefix.
 *
 */

class CcdbDatabase : public DatabaseInterface
{
 public:
  CcdbDatabase() = default;
  virtual ~CcdbDatabase();

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

  // storage
  void storeMO(std::shared_ptr<const o2::quality_control::core::MonitorObject> q, long from = -1, long to = -1) override;
  void storeQO(std::shared_ptr<const o2::quality_control::core::QualityObject> q, long from = -1, long to = -1) override;

  // retrieval - MO - deprecated
  std::shared_ptr<o2::quality_control::core::MonitorObject> retrieveMO(std::string taskName, std::string objectName, long timestamp = -1) override;
  std::string retrieveMOJson(std::string taskName, std::string objectName, long timestamp = -1) override;

  // retrieval - QO - deprecated
  std::shared_ptr<o2::quality_control::core::QualityObject> retrieveQO(std::string qoPath, long timestamp = -1) override;
  std::string retrieveQOJson(std::string qoPath, long timestamp = -1) override;

  // retrieval - general
  std::string retrieveJson(std::string path, long timestamp, const std::map<std::string, std::string>& metadata) override;
  TObject* retrieveTObject(std::string path, const std::map<std::string, std::string>& metadata, long timestamp = -1, std::map<std::string, std::string>* headers = nullptr) override;

  void disconnect() override;
  void prepareTaskDataContainer(std::string taskName) override;
  std::vector<std::string> getPublishedObjectNames(std::string taskName) override;
  void truncate(std::string taskName, std::string objectName) override;
  void storeStreamerInfosToFile(std::string filename);
  static long getCurrentTimestamp();
  static long getFutureTimestamp(int secondsInFuture);
  std::vector<std::string> getListing(std::string subpath = "");

 private:
  static void loadDeprecatedStreamerInfos();
  void init();

  std::string getListingAsString(std::string subpath = "", std::string accept = "text/plain");
  o2::ccdb::CcdbApi ccdbApi;
  std::string mUrl = "";
};

} // namespace o2::quality_control::repository

#endif // QC_REPOSITORY_CCDBDATABASE_H