datalake_file_client.hpp

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
 
#pragma once
 
#include "azure/storage/files/datalake/datalake_options.hpp"
#include "azure/storage/files/datalake/datalake_path_client.hpp"
#include "azure/storage/files/datalake/datalake_responses.hpp"
 
#include <azure/core/credentials/credentials.hpp>
#include <azure/core/internal/http/pipeline.hpp>
#include <azure/core/response.hpp>
#include <azure/storage/blobs/block_blob_client.hpp>
#include <azure/storage/common/storage_credential.hpp>
 
#include <cstdint>
#include <memory>
#include <string>
 
namespace Azure { namespace Storage { namespace Files { namespace DataLake {
 
  class DataLakeFileClient final : public DataLakePathClient {
  public:
    static DataLakeFileClient CreateFromConnectionString(
        const std::string& connectionString,
        const std::string& fileSystemName,
        const std::string& fileName,
        const DataLakeClientOptions& options = DataLakeClientOptions());
 
    explicit DataLakeFileClient(
        const std::string& fileUrl,
        std::shared_ptr<StorageSharedKeyCredential> credential,
        const DataLakeClientOptions& options = DataLakeClientOptions());
 
    explicit DataLakeFileClient(
        const std::string& fileUrl,
        std::shared_ptr<const Core::Credentials::TokenCredential> credential,
        const DataLakeClientOptions& options = DataLakeClientOptions());
 
    explicit DataLakeFileClient(
        const std::string& fileUrl,
        const DataLakeClientOptions& options = DataLakeClientOptions());
 
    std::string GetUrl() const { return m_blobClient.GetUrl(); }
 
    Azure::Response<Models::AppendFileResult> Append(
        Azure::Core::IO::BodyStream& content,
        int64_t offset,
        const AppendFileOptions& options = AppendFileOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::FlushFileResult> Flush(
        int64_t position,
        const FlushFileOptions& options = FlushFileOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::CreateFileResult> Create(
        const CreateFileOptions& options = CreateFileOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const
    {
      return DataLakePathClient::Create(Models::PathResourceType::File, options, context);
    }
 
    Azure::Response<Models::CreateFileResult> CreateIfNotExists(
        const CreateFileOptions& options = CreateFileOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const
    {
      return DataLakePathClient::CreateIfNotExists(
          Models::PathResourceType::File, options, context);
    }
 
    Azure::Response<Models::DeleteFileResult> Delete(
        const DeleteFileOptions& options = DeleteFileOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::DeleteFileResult> DeleteIfExists(
        const DeleteFileOptions& options = DeleteFileOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::DownloadFileResult> Download(
        const DownloadFileOptions& options = DownloadFileOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::UploadFileFromResult> UploadFrom(
        const uint8_t* buffer,
        size_t bufferSize,
        const UploadFileFromOptions& options = UploadFileFromOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::UploadFileFromResult> UploadFrom(
        const std::string& fileName,
        const UploadFileFromOptions& options = UploadFileFromOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::DownloadFileToResult> DownloadTo(
        uint8_t* buffer,
        size_t bufferSize,
        const DownloadFileToOptions& options = DownloadFileToOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::DownloadFileToResult> DownloadTo(
        const std::string& fileName,
        const DownloadFileToOptions& options = DownloadFileToOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::ScheduleFileDeletionResult> ScheduleDeletion(
        ScheduleFileExpiryOriginType expiryOrigin,
        const ScheduleFileDeletionOptions& options = ScheduleFileDeletionOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::QueryFileResult> Query(
        const std::string& querySqlExpression,
        const QueryFileOptions& options = QueryFileOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
  private:
    explicit DataLakeFileClient(
        Azure::Core::Url fileUrl,
        Blobs::BlobClient blobClient,
        std::shared_ptr<Azure::Core::Http::_internal::HttpPipeline> pipeline,
        _detail::DatalakeClientConfiguration clientConfiguration)
        : DataLakePathClient(
            std::move(fileUrl),
            std::move(blobClient),
            pipeline,
            std::move(clientConfiguration))
    {
    }
 
    friend class DataLakeFileSystemClient;
    friend class DataLakeDirectoryClient;
  };
}}}} // namespace Azure::Storage::Files::DataLake