timescaledb 0.2.1 → 0.2.3

data/lib/timescaledb/toolkit/helpers.rb

@@ -0,0 +1,20 @@
+require 'active_record/connection_adapters/postgresql_adapter'
+
+# Useful methods to run TimescaleDB with Toolkit functions in you Ruby app.
+module Timescaledb
+  # Helpers methods to setup queries that uses the toolkit.
+  module Toolkit
+    module Helpers
+
+      # Includes toolkit_experimental in the search path to make it easy to have
+      # access to all the functions
+      def add_toolkit_to_search_path!
+        return if schema_search_path.include?("toolkit_experimental")
+
+        self.schema_search_path = "#{schema_search_path}, toolkit_experimental"
+      end
+    end
+  end
+end
+
+ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include(Timescaledb::Toolkit::Helpers)

data/lib/timescaledb/toolkit/time_vector.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Timescaledb
+  module Toolkit
+    module TimeVector
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def value_column
+          @value_column ||= time_vector_options[:value_column] || :val
+        end
+
+        def time_column
+          respond_to?(:time_column) && super || time_vector_options[:time_column] 
+        end
+        def segment_by_column
+          time_vector_options[:segment_by]
+        end
+
+        protected
+
+        def define_default_scopes
+          scope :volatility, -> (segment_by: segment_by_column) do
+            select([*segment_by,
+               "timevector(#{time_column}, #{value_column}) -> sort() -> delta() -> abs() -> sum() as volatility"
+            ].join(", "))
+              .group(segment_by)
+          end
+
+          scope :time_weight, -> (segment_by: segment_by_column) do
+            select([*segment_by,
+               "timevector(#{time_column}, #{value_column}) -> sort() -> delta() -> abs() -> time_weight() as time_weight"
+            ].join(", "))
+              .group(segment_by)
+          end
+
+          scope :lttb, -> (threshold:, segment_by: segment_by_column, time: time_column, value: value_column) do
+            lttb_query = <<~SQL
+              WITH x AS ( #{select(*segment_by, time_column, value_column).to_sql})
+              SELECT #{"x.#{segment_by}," if segment_by}
+                (lttb( x.#{time_column}, x.#{value_column}, #{threshold})
+                 -> toolkit_experimental.unnest()).*
+              FROM x
+              #{"GROUP BY device_id" if segment_by}
+            SQL
+            downsampled = unscoped
+              .select(*segment_by, "time as #{time_column}, value as #{value_column}")
+              .from("(#{lttb_query}) as x")
+            if segment_by
+              downsampled.inject({}) do |group,e|
+                key = e.send(segment_by)
+                (group[key] ||= []) << [e.send(time_column), e.send(value_column)]
+                group
+              end
+            else
+              downsampled.map{|e|[ e[time_column],e[value_column]]}
+            end
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/timescaledb/toolkit.rb

@@ -0,0 +1,3 @@
+require_relative "toolkit/helpers"
+require_relative "acts_as_time_vector"
+require_relative "toolkit/time_vector"

data/lib/timescaledb/version.rb

@@ -1,3 +1,3 @@
 module Timescaledb
-  VERSION = '0.2.1'
+  VERSION = '0.2.3'
 end

data/lib/timescaledb.rb

@@ -2,6 +2,7 @@ require 'active_record'
 
 require_relative 'timescaledb/acts_as_hypertable'
 require_relative 'timescaledb/acts_as_hypertable/core'
+require_relative 'timescaledb/toolkit'
 require_relative 'timescaledb/chunk'
 require_relative 'timescaledb/compression_settings'
 require_relative 'timescaledb/continuous_aggregates'

data/mkdocs.yml

@@ -0,0 +1,33 @@
+site_name: The Timescaledb gem
+repo_url: https://github.com/jonatas/timescaledb
+edit_uri: edit/master/docs/
+extra:
+  analytics:
+    provider: google
+    property: G-9B2BMB0TNQ
+theme:
+  name: material
+  palette:
+    primary: indigo
+    accent: pink
+markdown_extensions:
+  - admonition
+  - codehilite:
+      guess_lang: false
+  - toc:
+      permalink: true
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+
+nav:
+  - Introduction: index.md
+  - Migrations: migrations.md
+  - Models: models.md
+  - Toolkit Integration: toolkit.md
+  - Toolkit LTTB Tutorial: toolkit_lttb_tutorial.md
+  - Zooming with High Resolution: toolkit_lttb_zoom.md
+  - Command Line: command_line.md
+  - Videos: videos.md

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timescaledb
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Jônatas Davi Paganini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-07 00:00:00.000000000 Z
+date: 2022-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -150,6 +150,7 @@ files:
 - ".tool-versions"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
+- Fastfile
 - Gemfile
 - Gemfile.lock
 - Gemfile.scenic
@@ -160,9 +161,21 @@ files:
 - bin/console
 - bin/setup
 - bin/tsdb
-- examples/all_in_one/Gemfile
-- examples/all_in_one/Gemfile.lock
+- docs/command_line.md
+- docs/img/lttb_example.png
+- docs/img/lttb_sql_vs_ruby.gif
+- docs/img/lttb_zoom.gif
+- docs/index.md
+- docs/migrations.md
+- docs/models.md
+- docs/toolkit.md
+- docs/toolkit_lttb_tutorial.md
+- docs/toolkit_lttb_zoom.md
+- docs/videos.md
 - examples/all_in_one/all_in_one.rb
+- examples/all_in_one/benchmark_comparison.rb
+- examples/all_in_one/caggs.rb
+- examples/all_in_one/query_data.rb
 - examples/ranking/.gitattributes
 - examples/ranking/.gitignore
 - examples/ranking/.ruby-version
@@ -212,9 +225,19 @@ files:
 - examples/ranking/tmp/pids/.keep
 - examples/ranking/tmp/storage/.keep
 - examples/ranking/vendor/.keep
+- examples/toolkit-demo/compare_volatility.rb
+- examples/toolkit-demo/lttb-zoom/README.md
+- examples/toolkit-demo/lttb-zoom/lttb_zoomable.rb
+- examples/toolkit-demo/lttb-zoom/views/index.erb
+- examples/toolkit-demo/lttb/README.md
+- examples/toolkit-demo/lttb/lttb.rb
+- examples/toolkit-demo/lttb/lttb_sinatra.rb
+- examples/toolkit-demo/lttb/lttb_test.rb
+- examples/toolkit-demo/lttb/views/index.erb
 - lib/timescaledb.rb
 - lib/timescaledb/acts_as_hypertable.rb
 - lib/timescaledb/acts_as_hypertable/core.rb
+- lib/timescaledb/acts_as_time_vector.rb
 - lib/timescaledb/chunk.rb
 - lib/timescaledb/compression_settings.rb
 - lib/timescaledb/continuous_aggregates.rb
@@ -227,7 +250,11 @@ files:
 - lib/timescaledb/scenic/extension.rb
 - lib/timescaledb/schema_dumper.rb
 - lib/timescaledb/stats_report.rb
+- lib/timescaledb/toolkit.rb
+- lib/timescaledb/toolkit/helpers.rb
+- lib/timescaledb/toolkit/time_vector.rb
 - lib/timescaledb/version.rb
+- mkdocs.yml
 - timescaledb.gemspec
 homepage: https://github.com/jonatas/timescaledb
 licenses:

data/examples/all_in_one/Gemfile

@@ -1,11 +0,0 @@
-
-source 'https://rubygems.org'
-
-gem "timescaledb", path: "../"
-gem "pg"
-gem "activerecord"
-gem "composite_primary_keys", "~> 6.0"
-gem 'pry'
-
-
-gem "dotenv", "~> 2.7"

data/examples/all_in_one/Gemfile.lock

@@ -1,51 +0,0 @@
-PATH
-  remote: ..
-  specs:
-    timescaledb (0.1.2)
-      activerecord
-      pg (~> 1.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (6.1.4.1)
-      activesupport (= 6.1.4.1)
-    activerecord (6.1.4.1)
-      activemodel (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
-    activesupport (6.1.4.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    coderay (1.1.3)
-    composite_primary_keys (6.0.5)
-      activerecord (>= 4.0.0)
-    concurrent-ruby (1.1.9)
-    dotenv (2.7.6)
-    i18n (1.8.10)
-      concurrent-ruby (~> 1.0)
-    method_source (1.0.0)
-    minitest (5.14.4)
-    pg (1.2.3)
-    pry (0.14.0)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-    zeitwerk (2.4.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord
-  composite_primary_keys (~> 6.0)
-  dotenv (~> 2.7)
-  pg
-  pry
-  timescaledb!
-
-BUNDLED WITH
-   2.1.4