ParquetTableComparator.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: Timo Sachsenberg $
// $Authors: Timo Sachsenberg $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/OpenMSConfig.h>
 
#include <string>
#include <vector>
 
namespace OpenMS
{
  struct OPENMS_DLLAPI ParquetDiffSettings
  {
    std::vector<std::string> primary_key;
    std::vector<std::string> ignore_columns;
    double acceptable_ratio = 1.0;
    double acceptable_absdiff = 0.0;
    bool schema_only = false;
    bool unordered_lists = false;
    Size max_reported = 25;
    bool compare_identity_columns = false;
  };
 
  struct OPENMS_DLLAPI ParquetDiffResult
  {
    bool equal = false;
    std::vector<std::string> schema_errors;
    std::vector<std::string> key_errors;
    std::vector<std::string> value_errors;
    Size suppressed = 0;
 
    Size rows_1 = 0;      
    Size rows_2 = 0;      
    Size rows_compared = 0;  
 
    double max_ratio = 1.0;
    double max_absdiff = 0.0;
 
    std::vector<std::string> primary_key_used;
  };
 
  class OPENMS_DLLAPI ParquetTableComparator
  {
  public:
    static ParquetDiffResult compare(const std::string& file_1,
                                     const std::string& file_2,
                                     const ParquetDiffSettings& settings);
 
    static ParquetDiffResult validate(const std::string& file,
                                      const std::string& view,
                                      const ParquetDiffSettings& settings);
 
    static bool dumpToTsv(const std::string& file,
                          const std::string& out_file,
                          const ParquetDiffSettings& settings);
 
    static std::vector<std::string> qpxPrimaryKey(const std::string& view);
 
    static std::vector<std::string> qpxIdentityColumns(const std::string& view);
 
    static std::string viewFromFileType(const std::string& file_type);
  };
 
} // namespace OpenMS