tsdb_ck/include/tsdb_hf.h

// High frequency data API

#ifndef TSDB_HF_CPP_HPP
#define TSDB_HF_CPP_HPP

#include <cstddef>
#include <cstdint>
#include <cstdio>
#include <cstring>
#include <memory>
#include <string_view>

#include "shared.h"

#ifdef _WIN32
#define TSDB_EXPORT __declspec(dllexport)
#else
#define TSDB_EXPORT
#endif

// NOTE: It is recommended to ALWAYS call `close` before dropping the object, otherwise you may
//       encounter unexpected behavior, including but not limited to silent data loss, crashes, etc.

namespace tsdb_hf_cpp {

using namespace tsdb_preludes;

struct tsdb_entry;

struct tsdb_entry_stream {
    struct impl;

    tsdb_entry_stream(std::nullptr_t);
    ~tsdb_entry_stream();
    tsdb_entry_stream(tsdb_entry_stream&& other);

    tsdb_entry_stream& operator=(tsdb_entry_stream rhs) {
        std::swap(impl_, rhs.impl_);
        return *this;
    }

    operator bool() const { return impl_ != nullptr; }

    /// @brief Closes the stream. Will also commit the stream if it has not been committed yet.
    /// It is recommended to always call this method before dropping the object.
    bool close();

    bool insert_point(double value);
    bool insert_points(const double* values, size_t count);

private:
    friend tsdb_entry;

    tsdb_entry_stream(std::unique_ptr<impl> impl);
    bool ensure_open() const;

    std::unique_ptr<impl> impl_;
};

/// @brief A time series database.
struct tsdb_entry {
    struct impl;

    tsdb_entry();
    tsdb_entry(std::nullptr_t);
    ~tsdb_entry();
    tsdb_entry(tsdb_entry&& other);

    tsdb_entry& operator=(tsdb_entry rhs) {
        std::swap(impl_, rhs.impl_);
        return *this;
    }

    operator bool() const { return impl_ != nullptr; }

    /// @brief Closes the database. Will fail if there are open streams. It is recommended to always
    /// call this method before dropping the object.
    bool close();

    bool set_data_dir(string_view data_dir);

    /// @brief Sets how many points are stored in a single part.
    bool set_part_size(size_t size);

    bool set_metric_name(string_view metric_name);

    /// @brief Creates a new stream of points. The stream will be automatically committed when
    /// the object is dropped.
    /// @param name
    /// @param timestampOffset The starting timestamp offset (since epoch), in milliseconds.
    /// @param interval The interval between points, in nanoseconds.
    /// @return An object representing the stream.
    tsdb_entry_stream new_stream(std::string name, uint64_t timestampOffset, uint64_t interval);

private:
    bool ensure_open() const;

    std::unique_ptr<impl> impl_;
};

}  // namespace tsdb_hf_cpp

#endif  // TSDB_HFCPP_HPP