Batch.h

/*
 * MIT License
 *
 * Copyright (c) 2026 F.D.Castel
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
 
#ifndef FBCPP_BATCH_H
#define FBCPP_BATCH_H
 
#include "fb-cpp-export.h"
#include "fb-api.h"
#include "Blob.h"
#include "Descriptor.h"
#include "SmartPtrs.h"
#include "Exception.h"
#include <cassert>
#include <cstddef>
#include <cstdint>
#include <optional>
#include <span>
#include <string_view>
#include <vector>
 
 
namespace fbcpp
{
    class Attachment;
    class Client;
    class Statement;
    class Transaction;
 
    enum class BlobPolicy : std::uint8_t
    {
        NONE = fb::IBatch::BLOB_NONE,
 
        ID_ENGINE = fb::IBatch::BLOB_ID_ENGINE,
 
        ID_USER = fb::IBatch::BLOB_ID_USER,
 
        STREAM = fb::IBatch::BLOB_STREAM,
    };
 
    class BatchOptions final
    {
    public:
        bool getMultiError() const
        {
            return multiError;
        }
 
        BatchOptions& setMultiError(bool value)
        {
            multiError = value;
            return *this;
        }
 
        bool getRecordCounts() const
        {
            return recordCounts;
        }
 
        BatchOptions& setRecordCounts(bool value)
        {
            recordCounts = value;
            return *this;
        }
 
        std::optional<unsigned> getBufferBytesSize() const
        {
            return bufferBytesSize;
        }
 
        BatchOptions& setBufferBytesSize(unsigned value)
        {
            bufferBytesSize = value;
            return *this;
        }
 
        BlobPolicy getBlobPolicy() const
        {
            return blobPolicy;
        }
 
        BatchOptions& setBlobPolicy(BlobPolicy value)
        {
            blobPolicy = value;
            return *this;
        }
 
        unsigned getDetailedErrors() const
        {
            return detailedErrors;
        }
 
        BatchOptions& setDetailedErrors(unsigned value)
        {
            detailedErrors = value;
            return *this;
        }
 
    private:
        bool multiError = false;
        bool recordCounts = false;
        std::optional<unsigned> bufferBytesSize;
        BlobPolicy blobPolicy = BlobPolicy::NONE;
        unsigned detailedErrors = 64;
    };
 
    class FB_CPP_EXPORT BatchCompletionState final
    {
    public:
        static constexpr int EXECUTE_FAILED = fb::IBatchCompletionState::EXECUTE_FAILED;
 
        static constexpr int SUCCESS_NO_INFO = fb::IBatchCompletionState::SUCCESS_NO_INFO;
 
    public:
        explicit BatchCompletionState(Client& client, FbUniquePtr<fb::IBatchCompletionState> handle) noexcept;
 
        BatchCompletionState(BatchCompletionState&& o) noexcept;
 
        BatchCompletionState& operator=(BatchCompletionState&&) = delete;
 
        BatchCompletionState(const BatchCompletionState&) = delete;
 
        BatchCompletionState& operator=(const BatchCompletionState&) = delete;
 
    public:
        unsigned getSize();
 
        int getState(unsigned pos);
 
        std::optional<unsigned> findError(unsigned pos);
 
        std::vector<std::intptr_t> getStatus(unsigned pos);
 
    private:
        Client* client;
        impl::StatusWrapper statusWrapper;
        FbUniquePtr<fb::IBatchCompletionState> handle;
    };
 
    class FB_CPP_EXPORT Batch final
    {
    public:
        explicit Batch(Statement& statement, Transaction& transaction, const BatchOptions& options = {});
 
        explicit Batch(Attachment& attachment, Transaction& transaction, std::string_view sql, unsigned dialect = 3,
            const BatchOptions& options = {});
 
        Batch(Batch&& o) noexcept;
 
        Batch& operator=(Batch&&) = delete;
 
        Batch(const Batch&) = delete;
 
        Batch& operator=(const Batch&) = delete;
 
        ~Batch() noexcept
        {
            if (isValid())
            {
                try
                {
                    close();
                }
                catch (...)
                {
                    // swallow
                }
            }
        }
 
    public:
        bool isValid() const noexcept
        {
            return handle != nullptr;
        }
 
 
        void add(unsigned count, const void* inBuffer);
 
        void addMessage();
 
 
 
        BlobId addBlob(std::span<const std::byte> data, const BlobOptions& bpb = {});
 
        void appendBlobData(std::span<const std::byte> data);
 
        void addBlobStream(std::span<const std::byte> data);
 
        BlobId registerBlob(const BlobId& existingBlob);
 
        void setDefaultBpb(const BlobOptions& bpb);
 
        unsigned getBlobAlignment();
 
 
 
        BatchCompletionState execute();
 
        void cancel();
 
        void close();
 
        FbRef<fb::IMessageMetadata> getInputMetadata();
 
        const std::vector<Descriptor>& getInputDescriptors();
 
 
    private:
        std::vector<std::uint8_t> buildParametersBlock(const BatchOptions& options);
        std::vector<std::uint8_t> prepareBpb(const BlobOptions& bpb);
        void buildInputDescriptors();
 
    private:
        Client* client;
        Transaction* transaction;
        Statement* statement = nullptr;
        impl::StatusWrapper statusWrapper;
        FbRef<fb::IBatch> handle;
        std::vector<Descriptor> inputDescriptors;
    };
}  // namespace fbcpp
 
 
#endif  // FBCPP_BATCH_H