timescaledb 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5f8ebd4460e965fbf9a35600630c05d476b1a4b674192cd925a3d5f948a64a1
-  data.tar.gz: d697ab124689a8c4f1ffc5b809a7cecd2ac07bbce84c7b9ca539dc5ae67068c9
+  metadata.gz: 06f324ce8793264ad6acb6a0f0f8f107511be08ecf2952e2fab285aeac366d35
+  data.tar.gz: d95da2805b53dafd174bb83fce7cf29cc2f13b5e8543bfa144d424e679aba701
 SHA512:
-  metadata.gz: 1070bf2f732137006d81790ac1c4b467f733edd3bb724e8773d3c9f6ecb3b5c1dc32c3da638f351589fa944a48c1b8f7a037da6a896beed1557e4fb34e2a8442
-  data.tar.gz: f5bc47e8c0022d079189e7ad68e2214da6760c4f420bca3c83950137dd7026985fb9239924c241b28f261546a860c744a32db154548bfc0f8871302d35109ff7
+  metadata.gz: 14ce31badc6ae1eae1f51161a806354fcaea6b2d39197498766b4cefa2022565410f7fc745adfbaf0d51b68d67454460f3aabab2a94444dd377a93193d0465b2
+  data.tar.gz: 573dd6b5ae3bcfa0948176a86561c080a860d72634e1800b750554a694e17a17890a31492e2702b38ced8444b5725586bfcca6cb23109c968748edeb509bcf12

data/.github/workflows/ci.yml

@@ -0,0 +1,72 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+#  schedule:
+#    - cron: '42 5 * * *'
+
+jobs:
+  test-in-container:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '3.1.2' ]
+        database:
+          - 'pg14.6-ts2.9.0-patroni-static-primary-latest'
+          - 'pg13.9-ts2.9-latest'
+
+    services:
+      database:
+        image: timescale/timescaledb-ha:${{matrix.database}}
+        env:
+          POSTGRES_USER: username
+          POSTGRES_PASSWORD: secret
+          POSTGRES_DB: testdb
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+
+    runs-on: ubuntu-latest
+    name: OS Ruby ${{matrix.ruby}} database ${{matrix.database}}
+    container: ruby:${{matrix.ruby}}
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Show Ruby Version
+      run: |
+        ruby -v
+
+    - name: Install psql
+      run: |
+        apt-get update
+        apt-get install -y postgresql-client
+
+    - name: Show PostgreSQL version and time
+      env:
+        PGPASSWORD: secret
+      run: |
+        echo "SELECT version()" | psql -h database -U username testdb
+        echo "SELECT CURRENT_TIME" | psql -h database -U username testdb
+
+    - name: Setup
+      run: |
+        ./bin/setup
+
+    - name: run tsdb
+      run: ./bin/tsdb postgres://username:secret@database:5432/testdb --stats
+
+    - name: Test setup
+      run: |
+        echo PG_URI_TEST="postgres://username:secret@database:5432/testdb" > .env
+        cat .env
+        bundle exec rake test:setup
+
+    - name: Test
+      run: bundle exec rake
+

data/.travis.yml

@@ -2,8 +2,8 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.7.1
-before_install: gem install bundler -v 2.1.4
+  - 3.1.2
+before_install: gem install bundler
 gemfile:
   - Gemfile
   - Gemfile.scenic

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    timescaledb (0.2.4)
+    timescaledb (0.2.6)
       activerecord
       activesupport
       pg (~> 1.2)
@@ -33,7 +33,7 @@ GEM
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
     minitest (5.14.4)
-    pg (1.4.4)
+    pg (1.4.5)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)

data/Gemfile.scenic.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    timescaledb (0.2.3)
+    timescaledb (0.2.6)
       activerecord
       activesupport
       pg (~> 1.2)
@@ -56,9 +56,7 @@ GEM
     nokogiri (1.12.5)
       mini_portile2 (~> 2.6.1)
       racc (~> 1.4)
-    nokogiri (1.12.5-x86_64-darwin)
-      racc (~> 1.4)
-    pg (1.4.4)
+    pg (1.4.5)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)

data/lib/timescaledb/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Timescaledb
+  class ApplicationRecord < ::ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/lib/timescaledb/chunk.rb

@@ -1,5 +1,5 @@
 module Timescaledb
-  class Chunk < ActiveRecord::Base
+  class Chunk < ::Timescaledb::ApplicationRecord
     self.table_name = "timescaledb_information.chunks"
     self.primary_key = "chunk_name"
 

data/lib/timescaledb/compression_settings.rb

@@ -1,5 +1,5 @@
 module Timescaledb
-  class CompressionSetting < ActiveRecord::Base
+  class CompressionSetting < ::Timescaledb::ApplicationRecord
     self.table_name = "timescaledb_information.compression_settings"
     belongs_to :hypertable, foreign_key: :hypertable_name
   end

data/lib/timescaledb/continuous_aggregates.rb

@@ -1,5 +1,5 @@
 module Timescaledb
-  class ContinuousAggregate < ActiveRecord::Base
+  class ContinuousAggregate < ::Timescaledb::ApplicationRecord
     self.table_name = "timescaledb_information.continuous_aggregates"
     self.primary_key = 'materialization_hypertable_name'
 

data/lib/timescaledb/dimensions.rb

@@ -1,5 +1,5 @@
 module Timescaledb
-  class Dimension < ActiveRecord::Base
+  class Dimension < ::Timescaledb::ApplicationRecord
     self.table_name = "timescaledb_information.dimensions"
 #    attribute :time_interval, :interval
   end

data/lib/timescaledb/hypertable.rb

@@ -1,5 +1,5 @@
 module Timescaledb
-  class Hypertable < ActiveRecord::Base
+  class Hypertable < ::Timescaledb::ApplicationRecord
     self.table_name = "timescaledb_information.hypertables"
     self.primary_key = "hypertable_name"
 

data/lib/timescaledb/job.rb

@@ -1,5 +1,5 @@
 module Timescaledb
-  class Job < ActiveRecord::Base
+  class Job < ::Timescaledb::ApplicationRecord
     self.table_name = "timescaledb_information.jobs"
     self.primary_key = "job_id"
 

data/lib/timescaledb/job_stats.rb

@@ -1,5 +1,5 @@
 module Timescaledb
-  class JobStat < ActiveRecord::Base
+  class JobStat < ::Timescaledb::ApplicationRecord
     self.table_name = "timescaledb_information.job_stats"
 
     belongs_to :job

data/lib/timescaledb/migration_helpers.rb

@@ -4,7 +4,12 @@ require 'active_record/connection_adapters/postgresql_adapter'
 module Timescaledb
   # Migration helpers can help you to setup hypertables by default.
   module MigrationHelpers
-    # create_table can receive `hypertable` argument
+    # `create_table` accepts a `hypertable` argument with options for creating
+    # a TimescaleDB hypertable.
+    #
+    # See https://docs.timescale.com/api/latest/hypertable/create_hypertable/#optional-arguments
+    # for additional options supported by the plugin.
+    #
     # @example
     #  options = {
     #    time_column: 'created_at',
@@ -27,15 +32,29 @@ module Timescaledb
     # Setup hypertable from options
     # @see create_table with the hypertable options.
     def create_hypertable(table_name,
-                                 time_column: 'created_at',
-                                 chunk_time_interval: '1 week',
-                                 compress_segmentby: nil,
-                                 compress_orderby: 'created_at',
-                                 compression_interval: nil
-                                )
+                          time_column: 'created_at',
+                          chunk_time_interval: '1 week',
+                          compress_segmentby: nil,
+                          compress_orderby: 'created_at',
+                          compression_interval: nil,
+                          partition_column: nil,
+                          number_partitions: nil,
+                          **hypertable_options)
 
       ActiveRecord::Base.logger = Logger.new(STDOUT)
-      execute "SELECT create_hypertable('#{table_name}', '#{time_column}', chunk_time_interval => INTERVAL '#{chunk_time_interval}')"
+
+      options = ["chunk_time_interval => INTERVAL '#{chunk_time_interval}'"]
+      options += hypertable_options.map { |k, v| "#{k} => #{quote(v)}" }
+
+      arguments = [
+        quote(table_name),
+        quote(time_column),
+        (quote(partition_column) if partition_column),
+        (number_partitions if partition_column),
+        *options
+      ]
+
+      execute "SELECT create_hypertable(#{arguments.compact.join(', ')})"
 
       if compress_segmentby
         execute <<~SQL

data/lib/timescaledb/scenic/extension.rb

@@ -68,5 +68,5 @@ module Timescaledb
 end
 
 
+Scenic::Adapters::Postgres.include(Timescaledb::Scenic::Extension)
 ActiveRecord::ConnectionAdapters::AbstractAdapter.include(Timescaledb::Scenic::MigrationHelpers)
-Scenic::Adapters::Postgres.prepend(Timescaledb::Scenic::Extension)

data/lib/timescaledb/schema_dumper.rb

@@ -5,31 +5,24 @@ module Timescaledb
   module SchemaDumper
     def tables(stream)
       super # This will call #table for each table in the database
-      views(stream) unless defined?(Scenic) # Don't call this twice if we're using Scenic
 
       return unless Timescaledb::Hypertable.table_exists?
 
       timescale_hypertables(stream)
       timescale_retention_policies(stream)
-    end
-
-    def views(stream)
-      return unless Timescaledb::ContinuousAggregates.table_exists?
-
       timescale_continuous_aggregates(stream) # Define these before any Scenic views that might use them
-      super if defined?(super)
     end
 
     def timescale_hypertables(stream)
-      stream.puts # Insert a blank line above the hypertable definitions, for readability
-
       sorted_hypertables.each do |hypertable|
-         timescale_hypertable(hypertable, stream)
+        timescale_hypertable(hypertable, stream)
       end
     end
 
     def timescale_retention_policies(stream)
-      stream.puts # Insert a blank line above the retention policies, for readability
+      if sorted_hypertables.any? { |hypertable| hypertable.jobs.exists?(proc_name: "policy_retention") }
+        stream.puts # Insert a blank line above the retention policies, for readability
+      end
 
       sorted_hypertables.each do |hypertable|
         timescale_retention_policy(hypertable, stream)
@@ -39,13 +32,18 @@ module Timescaledb
     private
 
     def timescale_hypertable(hypertable, stream)
-      dim = hypertable.main_dimension
-      extra_settings = {
-        time_column: "#{dim.column_name}",
-        chunk_time_interval: "#{dim.time_interval.inspect}"
-      }.merge(timescale_compression_settings_for(hypertable)).map {|k, v| %Q[#{k}: "#{v}"]}.join(", ")
-
-      stream.puts %Q[  create_hypertable "#{hypertable.hypertable_name}", #{extra_settings}]
+      time = hypertable.main_dimension
+
+      options = {
+        time_column: time.column_name,
+        chunk_time_interval: time.time_interval.inspect,
+        **timescale_compression_settings_for(hypertable),
+        **timescale_space_partition_for(hypertable),
+        **timescale_index_options_for(hypertable)
+      }
+
+      options = options.map { |k, v| "#{k}: #{v.to_json}" }.join(", ")
+      stream.puts %Q[  create_hypertable "#{hypertable.hypertable_name}", #{options}]
     end
 
     def timescale_retention_policy(hypertable, stream)
@@ -56,21 +54,64 @@ module Timescaledb
 
     def timescale_compression_settings_for(hypertable)
       compression_settings = hypertable.compression_settings.each_with_object({}) do |setting, compression_settings|
-        compression_settings[:compress_segmentby] = setting.attname if setting.segmentby_column_index
+        # It's possible to configure compression so that it is segmented by multiple
+        # columns. To make sure we capture that correctly, we'll treat them as an array.
+        compression_settings[:compress_segmentby] ||= []
+        compression_settings[:compress_orderby] ||= []
+
+        compression_settings[:compress_segmentby] << setting.attname if setting.segmentby_column_index
 
         if setting.orderby_column_index
-          direction = setting.orderby_asc ? "ASC" : "DESC"
-          compression_settings[:compress_orderby] = "#{setting.attname} #{direction}"
+          if setting.orderby_asc
+            direction = "ASC"
+            if setting.orderby_nullsfirst
+              direction += " NULLS FIRST"
+            end
+          else
+            direction = "DESC"
+            if !setting.orderby_nullsfirst
+              direction += " NULLS LAST"
+            end
+          end
+
+          compression_settings[:compress_orderby] << "#{setting.attname} #{direction}"
         end
       end
 
       hypertable.jobs.compression.each do |job|
         compression_settings[:compression_interval] = job.config["compress_after"]
       end
+
+      # Pack the compression setting arrays into a comma-separated string instead.
+      if compression_settings[:compress_segmentby]
+        compression_settings[:compress_segmentby] = compression_settings[:compress_segmentby].join(", ")
+      end
+      if compression_settings[:compress_orderby]
+        compression_settings[:compress_orderby] = compression_settings[:compress_orderby].join(", ")
+      end
+
       compression_settings
     end
 
+    def timescale_space_partition_for(hypertable)
+      return {} unless hypertable.dimensions.length > 1
+
+      space = hypertable.dimensions.last
+      {partition_column: space.column_name, number_partitions: space.num_partitions}
+    end
+
+    def timescale_index_options_for(hypertable)
+      time = hypertable.main_dimension
+      if @connection.indexes(hypertable.hypertable_name).any? { |i| i.columns == [time.column_name] }
+        {}
+      else
+        {create_default_indexes: false}
+      end
+    end
+
     def timescale_continuous_aggregates(stream)
+      return unless Timescaledb::ContinuousAggregates.table_exists?
+
       Timescaledb::ContinuousAggregates.all.each do |aggregate|
         opts = if (refresh_policy = aggregate.jobs.refresh_continuous_aggregate.first)
                  interval = timescale_interval(refresh_policy.schedule_interval)
@@ -95,6 +136,7 @@ module Timescaledb
 
       "INTERVAL '#{value}'"
     end
+
     def sorted_hypertables
       @sorted_hypertables ||= Timescaledb::Hypertable.order(:hypertable_name).to_a
     end

data/lib/timescaledb/version.rb

@@ -1,3 +1,3 @@
 module Timescaledb
-  VERSION = '0.2.4'
+  VERSION = '0.2.6'
 end

data/lib/timescaledb.rb

@@ -1,5 +1,6 @@
 require 'active_record'
 
+require_relative 'timescaledb/application_record'
 require_relative 'timescaledb/acts_as_hypertable'
 require_relative 'timescaledb/acts_as_hypertable/core'
 require_relative 'timescaledb/toolkit'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timescaledb
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors:
 - Jônatas Davi Paganini
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-16 00:00:00.000000000 Z
+date: 2023-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -144,6 +144,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
@@ -240,6 +241,7 @@ files:
 - lib/timescaledb/acts_as_hypertable.rb
 - lib/timescaledb/acts_as_hypertable/core.rb
 - lib/timescaledb/acts_as_time_vector.rb
+- lib/timescaledb/application_record.rb
 - lib/timescaledb/chunk.rb
 - lib/timescaledb/compression_settings.rb
 - lib/timescaledb/continuous_aggregates.rb