quasardb 3.14.1.dev5__cp312-cp312-win_amd64.whl → 3.14.2.dev0__cp312-cp312-win_amd64.whl

quasardb/metrics.hpp

@@ -0,0 +1,112 @@
+/*
+ *
+ * Official Python API
+ *
+ * Copyright (c) 2009-2024, quasardb SAS. All rights reserved.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ *    * Redistributions of source code must retain the above copyright
+ *      notice, this list of conditions and the following disclaimer.
+ *    * Redistributions in binary form must reproduce the above copyright
+ *      notice, this list of conditions and the following disclaimer in the
+ *      documentation and/or other materials provided with the distribution.
+ *    * Neither the name of quasardb nor the names of its contributors may
+ *      be used to endorse or promote products derived from this software
+ *      without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY QUASARDB AND CONTRIBUTORS ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+#pragma once
+
+#include <pybind11/pybind11.h>
+#include <pybind11/stl.h>
+#include <cassert>
+#include <chrono>
+#include <map>
+#include <string>
+
+namespace qdb
+{
+namespace py              = pybind11;
+using metrics_container_t = std::map<std::string, std::uint64_t>;
+
+class metrics
+{
+private:
+public:
+    /**
+     * Utility fixture that automatically records timings for a certain block of code.
+     * This is intended to be used from native C++ code only.
+     */
+    class scoped_capture
+    {
+        using clock_t      = std::chrono::high_resolution_clock;
+        using time_point_t = std::chrono::time_point<clock_t>;
+
+    public:
+        scoped_capture(std::string const & test_id) noexcept
+            : test_id_{test_id}
+            , start_{clock_t::now()} {};
+        ~scoped_capture();
+
+    private:
+        std::string test_id_;
+        time_point_t start_;
+    };
+
+    /**
+     * Utility class that's exposed to Python which can be used to record metrics in
+     * a scope. It makes it easy to track the difference between the beginning and end
+     * of execution.
+     */
+    class measure
+    {
+    public:
+        measure();
+        ~measure(){};
+
+    public:
+        measure enter()
+        {
+            // No-op, all initialization is done in the constructor.
+            return *this;
+        }
+
+        void exit(py::object /* type */, py::object /* value */, py::object /* traceback */)
+        {}
+
+        metrics_container_t get() const;
+
+    private:
+        metrics_container_t start_;
+    };
+
+public:
+    metrics() noexcept {};
+
+    ~metrics() noexcept {};
+
+public:
+    static void record(std::string const & test_id, std::uint64_t nsec);
+
+    static metrics_container_t totals();
+    static void clear();
+
+private:
+};
+
+void register_metrics(py::module_ & m);
+
+} // namespace qdb

quasardb/module.cpp

@@ -1,5 +1,6 @@
 #include "module.hpp"
 #include "cluster.hpp"
+#include "metrics.hpp"
 #include "node.hpp"
 #include "writer.hpp"
 #include <functional>
@@ -62,6 +63,7 @@ PYBIND11_MODULE(quasardb, m)
     qdb::register_table_reader(m);
     qdb::register_masked_array(m);
     qdb::register_writer(m);
+    qdb::register_metrics(m);
 
     qdb::detail::register_ts_column(m);
     qdb::reader::register_ts_value(m);

quasardb/node.hpp

@@ -2,7 +2,7 @@
  *
  * Official Python API
  *
- * Copyright (c) 2009-2023, quasardb SAS. All rights reserved.
+ * Copyright (c) 2009-2024, quasardb SAS. All rights reserved.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

quasardb/numpy.hpp

@@ -2,7 +2,7 @@
  *
  * Official Python API
  *
- * Copyright (c) 2009-2023, quasardb SAS. All rights reserved.
+ * Copyright (c) 2009-2024, quasardb SAS. All rights reserved.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

quasardb/options.hpp

@@ -2,7 +2,7 @@
  *
  * Official Python API
  *
- * Copyright (c) 2009-2023, quasardb SAS. All rights reserved.
+ * Copyright (c) 2009-2024, quasardb SAS. All rights reserved.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

quasardb/pandas/__init__.py

@@ -1,6 +1,6 @@
 # pylint: disable=C0103,C0111,C0302,R0903
 
-# Copyright (c) 2009-2023, quasardb SAS. All rights reserved.
+# Copyright (c) 2009-2024, quasardb SAS. All rights reserved.
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without

quasardb/perf.hpp

@@ -2,7 +2,7 @@
  *
  * Official Python API
  *
- * Copyright (c) 2009-2023, quasardb SAS. All rights reserved.
+ * Copyright (c) 2009-2024, quasardb SAS. All rights reserved.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

quasardb/pytypes.hpp

@@ -2,7 +2,7 @@
  *
  * Official Python API
  *
- * Copyright (c) 2009-2023, quasardb SAS. All rights reserved.
+ * Copyright (c) 2009-2024, quasardb SAS. All rights reserved.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

quasardb/query.cpp

@@ -2,7 +2,7 @@
  *
  * Official Python API
  *
- * Copyright (c) 2009-2023, quasardb SAS. All rights reserved.
+ * Copyright (c) 2009-2024, quasardb SAS. All rights reserved.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -31,6 +31,7 @@
 
 #include "query.hpp"
 #include "masked_array.hpp"
+#include "metrics.hpp"
 #include "numpy.hpp"
 #include "traits.hpp"
 #include "utils.hpp"
@@ -390,7 +391,12 @@ numpy_query_result_t numpy_query_results(const qdb_query_result_t * r)
 dict_query_result_t dict_query(qdb::handle_ptr h, const std::string & q, const py::object & blobs)
 {
     detail::qdb_resource<qdb_query_result_t> r{*h};
-    qdb_error_t err = qdb_query(*h, q.c_str(), &r);
+
+    qdb_error_t err;
+    {
+        metrics::scoped_capture capture{"qdb_query"};
+        err = qdb_query(*h, q.c_str(), &r);
+    }
 
     qdb::qdb_throw_if_query_error(*h, err, r.get());
 
@@ -400,7 +406,12 @@ dict_query_result_t dict_query(qdb::handle_ptr h, const std::string & q, const p
 numpy_query_result_t numpy_query(qdb::handle_ptr h, const std::string & q)
 {
     detail::qdb_resource<qdb_query_result_t> r{*h};
-    qdb_error_t err = qdb_query(*h, q.c_str(), &r);
+
+    qdb_error_t err;
+    {
+        metrics::scoped_capture capture{"qdb_query"};
+        err = qdb_query(*h, q.c_str(), &r);
+    }
     qdb::qdb_throw_if_query_error(*h, err, r.get());
 
     return numpy_query_results(r);

quasardb/query.hpp

@@ -2,7 +2,7 @@
  *
  * Official Python API
  *
- * Copyright (c) 2009-2023, quasardb SAS. All rights reserved.
+ * Copyright (c) 2009-2024, quasardb SAS. All rights reserved.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

quasardb/reader/ts_row.hpp

@@ -2,7 +2,7 @@
  *
  * Official Python API
  *
- * Copyright (c) 2009-2023, quasardb SAS. All rights reserved.
+ * Copyright (c) 2009-2024, quasardb SAS. All rights reserved.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

quasardb/reader/ts_value.hpp

@@ -2,7 +2,7 @@
  *
  * Official Python API
  *
- * Copyright (c) 2009-2023, quasardb SAS. All rights reserved.
+ * Copyright (c) 2009-2024, quasardb SAS. All rights reserved.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

quasardb/string.hpp

@@ -2,7 +2,7 @@
  *
  * Official Python API
  *
- * Copyright (c) 2009-2023, quasardb SAS. All rights reserved.
+ * Copyright (c) 2009-2024, quasardb SAS. All rights reserved.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

quasardb/table.cpp

@@ -1,5 +1,6 @@
 #include "table.hpp"
 #include "dispatch.hpp"
+#include "metrics.hpp"
 #include "object_tracker.hpp"
 #include "table_reader.hpp"
 #include "traits.hpp"
@@ -68,6 +69,39 @@ inline void insert_column_dispatch(handle_ptr handle,
 
 }; // namespace detail
 
+void table::_cache_metadata() const
+{
+    _handle->check_open();
+
+    detail::qdb_resource<qdb_ts_metadata_t> metadata{*_handle};
+
+    qdb_error_t err;
+
+    {
+        metrics::scoped_capture("qdb_ts_get_metadata");
+        err = qdb_ts_get_metadata(*_handle, _alias.c_str(), &metadata);
+    }
+
+    if (err == qdb_e_alias_not_found) [[unlikely]]
+    {
+        // Can happen if table does not yet exist, do nothing.
+        return;
+    }
+
+    qdb::qdb_throw_if_error(*_handle, err);
+
+    _columns = detail::convert_columns(metadata->columns, metadata->column_count);
+
+    if (metadata->ttl == qdb_ttl_disabled)
+    {
+        _ttl = std::chrono::milliseconds{0};
+    }
+    else
+    {
+        _ttl = std::chrono::milliseconds{metadata->ttl};
+    }
+}
+
 py::object table::reader(
     const std::vector<std::string> & columns, py::object ranges, bool dict_mode) const
 {

quasardb/table.hpp

@@ -2,7 +2,7 @@
  *
  * Official Python API
  *
- * Copyright (c) 2009-2023, quasardb SAS. All rights reserved.
+ * Copyright (c) 2009-2024, quasardb SAS. All rights reserved.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -44,7 +44,7 @@ public:
         : entry{h, a}
         , _has_indexed_columns(false)
     {
-        _cache_columns();
+        _cache_metadata();
     }
 
 public:
@@ -58,17 +58,24 @@ public:
      */
     void retrieve_metadata()
     {
-        _cache_columns();
+        _cache_metadata();
     }
 
     void create(const std::vector<detail::column_info> & columns,
-        std::chrono::milliseconds shard_size = std::chrono::hours{24})
+        std::chrono::milliseconds shard_size = std::chrono::hours{24},
+        std::chrono::milliseconds ttl        = std::chrono::milliseconds::zero())
     {
         _handle->check_open();
 
+        qdb_duration_t ttl_ = qdb_ttl_disabled;
+        if (ttl != std::chrono::milliseconds::zero())
+        {
+            ttl_ = ttl.count();
+        }
+
         const auto c_columns = detail::convert_columns_ex(columns);
         qdb::qdb_throw_if_error(*_handle, qdb_ts_create_ex(*_handle, _alias.c_str(), shard_size.count(),
-                                              c_columns.data(), c_columns.size()));
+                                              c_columns.data(), c_columns.size(), ttl_));
     }
 
     void insert_columns(const std::vector<detail::column_info> & columns)
@@ -87,7 +94,7 @@ public:
             return _columns.value();
         }
 
-        _cache_columns();
+        _cache_metadata();
 
         if (_columns.has_value()) [[likely]]
         {
@@ -152,38 +159,59 @@ public:
     py::object reader(
         const std::vector<std::string> & columns, py::object obj_ranges, bool dict_mode) const;
 
-private:
     /**
-     * Loads column info / metadata from server and caches it locally.
+     * Returns true if this table has a TTL assigned.
      */
-    void _cache_columns() const
+    inline bool has_ttl() const
     {
-        _handle->check_open();
+        if (_ttl.has_value()) [[likely]]
+        {
+            return _ttl.value() != std::chrono::milliseconds::zero();
+        }
 
-        detail::qdb_resource<qdb_ts_column_info_ex_t> columns{*_handle};
-        qdb_size_t count = 0;
+        _cache_metadata();
 
-        auto err = qdb_ts_list_columns_ex(*_handle, _alias.c_str(), &columns, &count);
+        if (_ttl.has_value()) [[likely]]
+        {
+            return _ttl.value() != std::chrono::milliseconds::zero();
+        }
 
-        if (err == qdb_e_alias_not_found) [[unlikely]]
+        throw qdb::alias_not_found_exception{};
+    }
+
+    inline std::chrono::milliseconds get_ttl() const
+    {
+        if (_ttl.has_value()) [[likely]]
         {
-            // Can happen if table does not yet exist, do nothing.
-            return;
+            return _ttl.value();
         }
 
-        qdb::qdb_throw_if_error(*_handle, err);
+        _cache_metadata();
+
+        if (_ttl.has_value()) [[likely]]
+        {
+            return _ttl.value();
+        }
 
-        _columns = detail::convert_columns(columns.get(), count);
+        throw qdb::alias_not_found_exception{};
     }
 
+private:
+    /**
+     * Loads column info / metadata from server and caches it locally.
+     */
+    void _cache_metadata() const;
+
     /**
      * Loads column info / metadata from server if not yet cached locally.
      */
-    void _maybe_cache_columns() const
+    void _maybe_cache_metadata() const
     {
         if (_columns.has_value() == false) [[unlikely]]
         {
-            _cache_columns();
+            // We expect _ttl and _columns to have the same state
+            assert(_ttl.has_value() == false);
+            _cache_metadata();
         }
     }
 
@@ -235,6 +263,7 @@ private:
     mutable detail::indexed_columns_t _indexed_columns;
 
     mutable std::optional<std::vector<detail::column_info>> _columns;
+    mutable std::optional<std::chrono::milliseconds> _ttl;
 };
 
 template <typename Module>
@@ -253,18 +282,21 @@ static inline void register_table(Module & m)
 
     py::class_<qdb::table, qdb::entry>{m, "Table", "Table representation"} //
         .def(py::init<qdb::handle_ptr, std::string>())                     //
-        .def("__repr__", &qdb::table::repr)
-        .def("create", &qdb::table::create, py::arg("columns"),
-            py::arg("shard_size") = std::chrono::hours{24})             //
-        .def("get_name", &qdb::table::get_name)                         //
-        .def("retrieve_metadata", &qdb::table::retrieve_metadata)       //
-        .def("column_index_by_id", &qdb::table::column_index_by_id)     //
-        .def("column_type_by_id", &qdb::table::column_type_by_id)       //
-        .def("column_info_by_index", &qdb::table::column_info_by_index) //
-        .def("column_type_by_index", &qdb::table::column_type_by_index) //
-        .def("column_id_by_index", &qdb::table::column_id_by_index)     //
-        .def("insert_columns", &qdb::table::insert_columns)             //
-        .def("list_columns", &qdb::table::list_columns)                 //
+        .def("__repr__", &qdb::table::repr)                                //
+        .def("create", &qdb::table::create, py::arg("columns"),            //
+            py::arg("shard_size") = std::chrono::hours{24},                //
+            py::arg("ttl")        = std::chrono::milliseconds::zero())            //
+        .def("get_name", &qdb::table::get_name)                            //
+        .def("retrieve_metadata", &qdb::table::retrieve_metadata)          //
+        .def("column_index_by_id", &qdb::table::column_index_by_id)        //
+        .def("column_type_by_id", &qdb::table::column_type_by_id)          //
+        .def("column_info_by_index", &qdb::table::column_info_by_index)    //
+        .def("column_type_by_index", &qdb::table::column_type_by_index)    //
+        .def("column_id_by_index", &qdb::table::column_id_by_index)        //
+        .def("insert_columns", &qdb::table::insert_columns)                //
+        .def("list_columns", &qdb::table::list_columns)                    //
+        .def("has_ttl", &qdb::table::has_ttl)                              //
+        .def("get_ttl", &qdb::table::get_ttl)                              //
 
         // We cannot initialize columns with all columns by default, because i don't
         // see a way to figure out the `this` address for qdb_ts_reader for the default

quasardb/table_reader.hpp

@@ -2,7 +2,7 @@
  *
  * Official Python API
  *
- * Copyright (c) 2009-2023, quasardb SAS. All rights reserved.
+ * Copyright (c) 2009-2024, quasardb SAS. All rights reserved.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

quasardb/tag.hpp

@@ -2,7 +2,7 @@
  *
  * Official Python API
  *
- * Copyright (c) 2009-2023, quasardb SAS. All rights reserved.
+ * Copyright (c) 2009-2024, quasardb SAS. All rights reserved.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

quasardb/timestamp.hpp

@@ -2,7 +2,7 @@
  *
  * Official Python API
  *
- * Copyright (c) 2009-2023, quasardb SAS. All rights reserved.
+ * Copyright (c) 2009-2024, quasardb SAS. All rights reserved.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

quasardb/utils.hpp

@@ -2,7 +2,7 @@
  *
  * Official Python API
  *
- * Copyright (c) 2009-2023, quasardb SAS. All rights reserved.
+ * Copyright (c) 2009-2024, quasardb SAS. All rights reserved.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

quasardb/writer.cpp

@@ -1,6 +1,7 @@
 #include "writer.hpp"
 #include "concepts.hpp"
 #include "dispatch.hpp"
+#include "metrics.hpp"
 #include "numpy.hpp"
 #include "traits.hpp"
 #include "convert/array.hpp"
@@ -491,6 +492,9 @@ void writer::_push_impl(writer::staged_tables_t & staged_tables,
             batch_table.data.column_count, table_name);
     }
 
+    // Make sure to measure the time it takes to do the actual push
+    qdb::metrics::scoped_capture capture{"qdb_batch_push"};
+
     qdb::qdb_throw_if_error(
         *_handle, qdb_exp_batch_push(*_handle, mode, batch.data(), nullptr, batch.size()));
 }

quasardb/writer.hpp

@@ -2,7 +2,7 @@
  *
  * Official Python API
  *
- * Copyright (c) 2009-2023, quasardb SAS. All rights reserved.
+ * Copyright (c) 2009-2024, quasardb SAS. All rights reserved.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

{quasardb-3.14.1.dev5.dist-info → quasardb-3.14.2.dev0.dist-info}/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2023, quasardb SAS. All rights reserved.
+Copyright (c) 2009-2024, quasardb SAS. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 

{quasardb-3.14.1.dev5.dist-info → quasardb-3.14.2.dev0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: quasardb
-Version: 3.14.1.dev5
+Version: 3.14.2.dev0
 Summary: Python API for quasardb
 Home-page: https://www.quasardb.net/
 Author: quasardb SAS