SDUtils.h

Go to the documentation of this file.

// ============================================================================
// Copyright 2017-2023, Schlumberger
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ============================================================================

#pragma once

#include "DLL_EXPORT.h"

#include <string>
#include <vector>

#include "SDManager.h"

namespace seismicdrive
{
    /*******************************************************************************/ 
    class DLL_PUBLIC SDUtils
    {
      public:
        /*******************************************************************************/ 
        SDUtils(SDManager *sdmanager);

        /*******************************************************************************/ 
        ~SDUtils();

        /*******************************************************************************/ 
        SDUtils(SDUtils &&rhf) noexcept;

        /*******************************************************************************/ 
        SDUtils &operator=(SDUtils &&rhf) noexcept;

        /*******************************************************************************/ 
        SDUtils(const SDUtils &rhs);

        /*******************************************************************************/ 
        SDUtils &operator=(const SDUtils &rhs);

        /*******************************************************************************/ 
        std::vector<bool> datasetsExist(const std::vector<std::string> &sdfileNames);

        /*******************************************************************************/ 
        bool datasetExist(const std::string &fileName);

        /*******************************************************************************/ 
        bool datasetExists(const std::string &fileName);

        /*******************************************************************************/ 
        std::vector<int64_t> datasetsSize(const std::vector<std::string> &sdfileNames);

        /*******************************************************************************/ 
        std::vector<int64_t> datasetSizes(const std::vector<std::string> &sdfileNames);

        /*******************************************************************************/ 
        int64_t datasetSize(const std::string &fileName);

        /*******************************************************************************/ 
        void deleteDataset(const std::string &sddatasetname);

        /*******************************************************************************/ 
        void deleteDatasetSync(const std::string &datasetUri);

        /*******************************************************************************/ 
        bool blockExists(const std::string &datasetpath, int blocknum) const;

        /*******************************************************************************/ 
        bool blockExists(const std::string &datasetpath, const std::string &blockName) const;

        /*******************************************************************************/ 
        std::vector<std::vector<std::string>> readDirectory(const std::string &sddirectorypath) const;

        /*******************************************************************************/ 
        std::pair<std::vector<std::string>, std::vector<std::string>> ls(const std::string &path, std::string& cursor, int limit=10000) const;

        /*******************************************************************************/ 
        std::vector<std::string> datasetList(const std::string &subProjectPath, std::string& cursor, int limit=100) const;

        /*******************************************************************************/ 
        std::string bulkDelete(const std::string &path) const;

        /*******************************************************************************/ 
        std::string bulkDeleteSubProjectPath(std::string &subProjectPath) const;

        /*******************************************************************************/ 
        std::string bulkDeleteDataset(std::string &datasetPath) const;

        /*******************************************************************************/ 
        BulkDeleteStatus bulkDeleteStatus(const std::string &operationId, const std::string &dataPartitionId) const;

        /*******************************************************************************/ 
        std::string bulkChangeTier(const std::string &path, const std::string &storageTier) const;

        /*******************************************************************************/ 
        std::string bulkChangeTierSubProjectPath(std::string &subProjectPath, const std::string &storageTier) const;

        /*******************************************************************************/ 
        std::string bulkChangeTierDataset(std::string &datasetPath, const std::string &storageTier) const;

        /*******************************************************************************/ 
        BulkChangeTierStatus bulkChangeTierStatus(const std::string &operationId, const std::string &dataPartitionId) const;

        /*******************************************************************************/ 
        std::string getServiceCloudProivider() const;

        /*******************************************************************************
         * @brief Upload a file
         *
         * This method can be used to upload a file into a single object
         *
         * prerequisites:
         * The dataset must not been open
         * File to upload must exist
         *
         * usage example:

         * - std::string fileToUpload = "/path/to/your.file"
         * - std::ifstream infile(fileToUpload);
         * - if(!infile.good())
         * -    return 0
         *
         * - SDManager sdmanager;
         * - SDUtils utils(&sdmanager);
         * - utils.upload("sd://tenant/subproject/path/your.file", fileToUpload);
         *
         * @param datasetpath is the seismic drive dataset name ( sd://tenant/subproject/path/dataset )
         * @param filename is the path of the file to upload
         *
         * failure mode:
         * @throw error::dataset::Error if dataset is currently open
         ******************************************************************************/
        void upload(const std::string &datasetpath, const std::string &filename) const;

        /*******************************************************************************/ 
        static bool isSDDatasetPath(const std::string &datasetpath);

        /*******************************************************************************/ 
        std::string getCreatedDate(const std::string &seistoreDatasetPath) const;

        /*******************************************************************************/ 
        std::string getLastModifiedDate(const std::string &seistoreDatasetPath) const;

        /*******************************************************************************/ 
        std::string getCreatedBy(const std::string &seistoreDatasetPath) const;

        /*******************************************************************************/ 
        std::string getType(const std::string &seistoreDatasetPath) const;

        /*******************************************************************************/ 
        std::string getLegalTag(const std::string &seistoreDatasetPath) const;

        /*******************************************************************************/ 
        std::string getFileMetaData(const std::string &seistoreDatasetPath) const;

        /*******************************************************************************/ 
        void datasetUnlock(const std::string &seistoreDatasetPath) const;

        /*******************************************************************************/ 
        std::string getOpenSessionID(const std::string &seistoreDatasetPath) const;

        /*******************************************************************************
         * @brief Update the StorageTier of a dataset
         *
         * This method can be used to update all of a dataset's blobs to an available storage tier
         *
         * usage example:
         * - SDManager sdmanager;
         * - SDUtils utils(&sdmanager);
         * - utils.updateStorageTier(path, StorageTier::COOL);
         *
         * @param sdpath is the seismic-store dataset path
         * @param storageTier is the storage tier the dataset to chanage to
         * 
         * @return A bool value representing the completion of storage tier change operation.
         ******************************************************************************/
        bool updateStorageTier(const std::string &sdpath, const std::string &storageTier) const;

      private:
#ifdef _MSC_VER
    #pragma warning(push)
    #pragma warning(disable : 4251)
#endif

        class Impl;

        std::unique_ptr<Impl> _impl;

#ifdef _MSC_VER
    #pragma warning(pop)
#endif

        friend class SDUtilsTest;
    };
}