timescaledb-rails 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fc0e42b6db3e42267d014923180abf3c64a643937942b8b3f17ad9b2a3bf223
-  data.tar.gz: 96c3105df56f184894cdd7e3ca8658b083a87e8a050711c17e52eeae6c836c3e
+  metadata.gz: 8e350967c0553e59b57a773226c1b532f9e1e2a93a03b1908c7228816c942d39
+  data.tar.gz: 6636c247f01919bfd344f8ff4afb7a74eaff050f4ec3246b64f24904c3046752
 SHA512:
-  metadata.gz: 9988f806f0512c73456e531dd42dfe3f3c5765d9ee426bcf6f4b45e3098568fcac3518884abde8fb473a42cba66d73aa4558631b2806256ea4726496a212bdb9
-  data.tar.gz: e85fa03def618ed5d114275a6f2b929871ca0c0ea52e95ada85cca332baa2f1252f8a6bc3fc29be544aaa8dc8225dbcda52df83903bedd530a63b3683be30e8b
+  metadata.gz: a96ee3099632fa74997735f6bbef27971be5f65d0e54e2978c90d4df7ae0ea64a7478acd0ffec787d05bcb0c7126a0ee51937fa4d59b03fc1fbb5c80bb20189c
+  data.tar.gz: 6bdd3e8bfe645fea36dc66461d6c4773d560d86d9af79c0bbb5a7a6d1d11eaf424898b6f3e07591b03828a2b2a521581b6a47783bb60e8dfa3b2b2a8e3ff8721

data/README.md

@@ -51,16 +51,20 @@ class CreatePayloadHypertable < ActiveRecord::Migration[7.0]
 end
 ```
 
-Add hypertable compression
+Add hypertable compression policy
 
 ```ruby
-class AddEventCompression < ActiveRecord::Migration[7.0]
+class AddEventCompressionPolicy < ActiveRecord::Migration[7.0]
   def up
-    add_hypertable_compression :events, 20.days, segment_by: :name, order_by: 'occurred_at DESC'
+    enable_hypertable_compression :events, segment_by: :name, order_by: 'occurred_at DESC'
+
+    add_hypertable_compression_policy :events, 20.days
   end
 
   def down
-    remove_hypertable_compression :events
+    remove_hypertable_compression_policy :events
+
+    disable_hypertable_compression :events
   end
 end
 ```
@@ -97,6 +101,8 @@ Create continuous aggregate
 
 ```ruby
 class CreateTemperatureEventAggregate < ActiveRecord::Migration[7.0]
+  disable_ddl_transaction!
+
   def up
     create_continuous_aggregate(
       :temperature_events,

data/lib/timescaledb/rails/extensions/active_record/command_recorder.rb

@@ -5,48 +5,27 @@ module Timescaledb
     module ActiveRecord
       # :nodoc:
       module CommandRecorder
-        def create_hypertable(*args, &block)
-          record(:create_hypertable, args, &block)
-        end
-
-        def add_hypertable_compression(*args, &block)
-          record(:add_hypertable_compression, args, &block)
-        end
-
-        def remove_hypertable_compression(*args, &block)
-          record(:remove_hypertable_compression, args, &block)
-        end
-
-        def add_hypertable_reorder_policy(*args, &block)
-          record(:add_hypertable_reorder_policy, args, &block)
-        end
-
-        def remove_hypertable_reorder_policy(*args, &block)
-          record(:remove_hypertable_reorder_policy, args, &block)
-        end
-
-        def add_hypertable_retention_policy(*args, &block)
-          record(:add_hypertable_retention_policy, args, &block)
-        end
-
-        def remove_hypertable_retention_policy(*args, &block)
-          record(:remove_hypertable_retention_policy, args, &block)
-        end
-
-        def create_continuous_aggregate(*args, &block)
-          record(:create_continuous_aggregate, args, &block)
-        end
-
-        def drop_continuous_aggregate(*args, &block)
-          record(:drop_continuous_aggregate, args, &block)
-        end
-
-        def add_continuous_aggregate_policy(*args, &block)
-          record(:add_continuous_aggregate_policy, args, &block)
-        end
-
-        def remove_continuous_aggregate_policy(*args, &block)
-          record(:remove_continuous_aggregate_policy, args, &block)
+        %w[
+          create_hypertable
+          enable_hypertable_compression
+          disable_hypertable_compression
+          add_hypertable_compression_policy
+          remove_hypertable_compression_policy
+          add_hypertable_reorder_policy
+          remove_hypertable_reorder_policy
+          add_hypertable_retention_policy
+          remove_hypertable_retention_policy
+          create_continuous_aggregate
+          drop_continuous_aggregate
+          add_continuous_aggregate_policy
+          remove_continuous_aggregate_policy
+        ].each do |method|
+          module_eval <<-METHOD, __FILE__, __LINE__ + 1
+            def #{method}(*args, &block)          # def create_table(*args, &block)
+              record(:"#{method}", args, &block)  #   record(:create_table, args, &block)
+            end                                   # end
+          METHOD
+          ruby2_keywords(method) if respond_to?(:ruby2_keywords)
         end
 
         def invert_create_hypertable(args, &block)
@@ -57,16 +36,24 @@ module Timescaledb
           [:drop_table, args.first, block]
         end
 
-        def invert_add_hypertable_compression(args, &block)
-          [:remove_hypertable_compression, args, block]
+        def invert_enable_hypertable_compression(args, &block)
+          [:disable_hypertable_compression, args, block]
+        end
+
+        def invert_disable_hypertable_compression(args, &block)
+          [:enable_hypertable_compression, args, block]
+        end
+
+        def invert_add_hypertable_compression_policy(args, &block)
+          [:remove_hypertable_compression_policy, args, block]
         end
 
-        def invert_remove_hypertable_compression(args, &block)
+        def invert_remove_hypertable_compression_policy(args, &block)
           if args.size < 2
-            raise ::ActiveRecord::IrreversibleMigration, 'remove_hypertable_compression is only reversible if given table name and compress period.' # rubocop:disable Layout/LineLength
+            raise ::ActiveRecord::IrreversibleMigration, 'remove_hypertable_compression_policy is only reversible if given table name and compress period.' # rubocop:disable Layout/LineLength
           end
 
-          [:add_hypertable_compression, args, block]
+          [:add_hypertable_compression_policy, args, block]
         end
 
         def invert_add_hypertable_retention_policy(args, &block)

data/lib/timescaledb/rails/extensions/active_record/postgresql_database_tasks.rb

@@ -27,7 +27,8 @@ module Timescaledb
             Timescaledb::Rails::Hypertable.all.each do |hypertable|
               drop_ts_insert_trigger_statment(hypertable, file)
               create_hypertable_statement(hypertable, file)
-              add_hypertable_compression_statement(hypertable, file)
+              enable_hypertable_compression_statement(hypertable, file)
+              add_hypertable_compression_policy_statement(hypertable, file)
               add_hypertable_reorder_policy_statement(hypertable, file)
               add_hypertable_retention_policy_statement(hypertable, file)
             end
@@ -36,7 +37,7 @@ module Timescaledb
 
         def continuous_aggregates(filename)
           File.open(filename, 'a') do |file|
-            Timescaledb::Rails::ContinuousAggregate.all.each do |continuous_aggregate|
+            Timescaledb::Rails::ContinuousAggregate.dependency_ordered.each do |continuous_aggregate|
               create_continuous_aggregate_statement(continuous_aggregate, file)
               add_continuous_aggregate_policy_statement(continuous_aggregate, file)
             end
@@ -56,12 +57,17 @@ module Timescaledb
           file << "SELECT create_hypertable('#{hypertable.hypertable_schema}.#{hypertable.hypertable_name}', '#{hypertable.time_column_name}', #{options});\n\n"
         end
 
-        def add_hypertable_compression_statement(hypertable, file)
+        def enable_hypertable_compression_statement(hypertable, file)
           return unless hypertable.compression?
 
           options = hypertable_compression_options(hypertable)
 
           file << "ALTER TABLE #{hypertable.hypertable_schema}.#{hypertable.hypertable_name} SET (#{options});\n\n"
+        end
+
+        def add_hypertable_compression_policy_statement(hypertable, file)
+          return unless hypertable.compression_policy?
+
           file << "SELECT add_compression_policy('#{hypertable.hypertable_schema}.#{hypertable.hypertable_name}', INTERVAL '#{hypertable.compression_policy_interval}');\n\n"
         end
 
@@ -139,7 +145,7 @@ module Timescaledb
 
         # @return [Boolean]
         def timescale_enabled?
-          Timescaledb::Rails::Hypertable.table_exists?
+          ApplicationRecord.timescale_connection?(connection) && Hypertable.table_exists?
         end
       end
       # rubocop:enable Layout/LineLength

data/lib/timescaledb/rails/extensions/active_record/schema_dumper.rb

@@ -19,9 +19,9 @@ module Timescaledb
         def continuous_aggregates(stream)
           return unless timescale_enabled?
 
-          Timescaledb::Rails::ContinuousAggregate.all.each do |continuous_aggregate|
-            continuous_aggregate(continuous_aggregate, stream)
-            continuous_aggregate_policy(continuous_aggregate, stream)
+          Timescaledb::Rails::ContinuousAggregate.dependency_ordered.each do |ca|
+            continuous_aggregate(ca, stream)
+            continuous_aggregate_policy(ca, stream)
           end
         end
 
@@ -55,8 +55,9 @@ module Timescaledb
 
           hypertable(hypertable, stream)
           hypertable_compression(hypertable, stream)
-          hypertable_reorder(hypertable, stream)
-          hypertable_retention(hypertable, stream)
+          hypertable_compression_policy(hypertable, stream)
+          hypertable_reorder_policy(hypertable, stream)
+          hypertable_retention_policy(hypertable, stream)
         end
 
         private
@@ -72,14 +73,22 @@ module Timescaledb
         def hypertable_compression(hypertable, stream)
           return unless hypertable.compression?
 
+          options = [hypertable.hypertable_name.inspect, hypertable_compression_options(hypertable)]
+
+          stream.puts "  enable_hypertable_compression #{options.join(', ')}"
+          stream.puts
+        end
+
+        def hypertable_compression_policy(hypertable, stream)
+          return unless hypertable.compression_policy?
+
           options = [hypertable.hypertable_name.inspect, hypertable.compression_policy_interval.inspect]
-          options |= hypertable_compression_options(hypertable)
 
-          stream.puts "  add_hypertable_compression #{options.join(', ')}"
+          stream.puts "  add_hypertable_compression_policy #{options.join(', ')}"
           stream.puts
         end
 
-        def hypertable_reorder(hypertable, stream)
+        def hypertable_reorder_policy(hypertable, stream)
           return unless hypertable.reorder?
 
           options = [hypertable.hypertable_name.inspect, hypertable.reorder_policy_index_name.inspect]
@@ -88,7 +97,7 @@ module Timescaledb
           stream.puts
         end
 
-        def hypertable_retention(hypertable, stream)
+        def hypertable_retention_policy(hypertable, stream)
           return unless hypertable.retention?
 
           options = [hypertable.hypertable_name.inspect, hypertable.retention_policy_interval.inspect]
@@ -140,7 +149,7 @@ module Timescaledb
         end
 
         def timescale_enabled?
-          Timescaledb::Rails::Hypertable.table_exists?
+          ApplicationRecord.timescale_connection?(@connection) && Hypertable.table_exists?
         end
       end
     end

data/lib/timescaledb/rails/extensions/active_record/schema_statements.rb

@@ -40,29 +40,42 @@ module Timescaledb
           execute "SELECT create_hypertable('#{table_name}', '#{time_column_name}', #{options_as_sql});"
         end
 
-        # Enables compression and sets compression options.
+        # Enables compression on given hypertable.
         #
-        #   add_hypertable_compression('events', 7.days, segment_by: :created_at, order_by: :name)
+        #   enable_hypertable_compression('events', segment_by: :created_at, order_by: :name)
         #
-        def add_hypertable_compression(table_name, compress_after, segment_by: nil, order_by: nil)
-          compress_after = compress_after.inspect if compress_after.is_a?(ActiveSupport::Duration)
-
+        def enable_hypertable_compression(table_name, segment_by: nil, order_by: nil)
           options = ['timescaledb.compress']
           options << "timescaledb.compress_orderby = '#{order_by}'" unless order_by.nil?
           options << "timescaledb.compress_segmentby = '#{segment_by}'" unless segment_by.nil?
 
           execute "ALTER TABLE #{table_name} SET (#{options.join(', ')});"
+        end
+
+        # Disables compression on given hypertable.
+        #
+        #   disable_hypertable_compression('events')
+        #
+        def disable_hypertable_compression(table_name, segment_by: nil, order_by: nil) # rubocop:disable Lint/UnusedMethodArgument
+          execute "ALTER TABLE #{table_name} SET (timescaledb.compress = false);"
+        end
+
+        # Adds compression policy to given hypertable.
+        #
+        #   add_hypertable_compression_policy('events', 7.days)
+        #
+        def add_hypertable_compression_policy(table_name, compress_after)
+          compress_after = compress_after.inspect if compress_after.is_a?(ActiveSupport::Duration)
 
           execute "SELECT add_compression_policy('#{table_name}', INTERVAL '#{stringify_interval(compress_after)}');"
         end
 
-        # Removes compression policy and disables compression from given hypertable.
+        # Removes compression policy from the given hypertable.
         #
-        #   remove_hypertable_compression('events')
+        #   remove_hypertable_compression_policy('events')
         #
-        def remove_hypertable_compression(table_name, compress_after = nil, segment_by: nil, order_by: nil) # rubocop:disable Lint/UnusedMethodArgument
+        def remove_hypertable_compression_policy(table_name, _compress_after = nil)
           execute "SELECT remove_compression_policy('#{table_name}');"
-          execute "ALTER TABLE #{table_name.inspect} SET (timescaledb.compress = false);"
         end
 
         # Add a data retention policy to given hypertable.
@@ -103,15 +116,22 @@ module Timescaledb
         #     'temperature_events', "SELECT * FROM events where event_type = 'temperature'"
         #   )
         #
-        def create_continuous_aggregate(view_name, view_query)
-          execute "CREATE MATERIALIZED VIEW #{view_name} WITH (timescaledb.continuous) AS #{view_query};"
+        def create_continuous_aggregate(view_name, view_query, force: false)
+          if force
+            execute "DROP MATERIALIZED VIEW #{quote_table_name(view_name)} CASCADE;" if view_exists? view_name
+          else
+            schema_cache.clear_data_source_cache!(view_name.to_s)
+          end
+
+          execute "CREATE MATERIALIZED VIEW #{quote_table_name(view_name)} " \
+                  "WITH (timescaledb.continuous) AS #{view_query};"
         end
 
         # Drops a continuous aggregate
         #
         #   drop_continuous_aggregate('temperature_events')
         #
-        def drop_continuous_aggregate(view_name, _view_query = nil)
+        def drop_continuous_aggregate(view_name, _view_query = nil, force: false) # rubocop:disable Lint/UnusedMethodArgument
           execute "DROP MATERIALIZED VIEW #{view_name};"
         end
 

data/lib/timescaledb/rails/model/hyperfunctions.rb

@@ -10,12 +10,18 @@ module Timescaledb
         TIME_BUCKET_ALIAS = 'time_bucket'
 
         # @return [ActiveRecord::Relation<ActiveRecord::Base>]
-        def time_bucket(interval, target_column = nil)
-          target_column ||= hypertable_time_column_name
+        def time_bucket(interval, target_column = nil, select_alias: TIME_BUCKET_ALIAS)
+          target_column &&= Arel.sql(target_column.to_s)
+          target_column ||= arel_table[hypertable_time_column_name]
 
-          select("time_bucket('#{format_interval_value(interval)}', #{target_column}) as #{TIME_BUCKET_ALIAS}")
-            .group(TIME_BUCKET_ALIAS)
-            .order(TIME_BUCKET_ALIAS)
+          time_bucket = Arel::Nodes::NamedFunction.new(
+            'time_bucket',
+            [Arel::Nodes.build_quoted(format_interval_value(interval)), target_column]
+          )
+
+          select(time_bucket.dup.as(select_alias))
+            .group(time_bucket)
+            .order(time_bucket)
             .extending(AggregateFunctions)
         end
 

data/lib/timescaledb/rails/models/application_record.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Timescaledb
+  module Rails
+    # :nodoc:
+    class ApplicationRecord < ::ActiveRecord::Base
+      self.abstract_class = true
+
+      def self.timescale_connection?(connection)
+        pool_name = lambda do |pool|
+          if pool.respond_to?(:db_config)
+            pool.db_config.name
+          elsif pool.respond_to?(:spec)
+            pool.spec.name
+          else
+            raise "Don't know how to get pool name from #{pool.inspect}"
+          end
+        end
+
+        pool_name[connection.pool] == pool_name[self.connection.pool]
+      end
+    end
+  end
+end

data/lib/timescaledb/rails/models/chunk.rb

@@ -3,7 +3,7 @@
 module Timescaledb
   module Rails
     # :nodoc:
-    class Chunk < ::ActiveRecord::Base
+    class Chunk < ApplicationRecord
       self.table_name = 'timescaledb_information.chunks'
       self.primary_key = 'hypertable_name'
 
@@ -17,13 +17,13 @@ module Timescaledb
       end
 
       def compress!
-        ::ActiveRecord::Base.connection.execute(
+        self.class.connection.execute(
           "SELECT compress_chunk('#{chunk_full_name}')"
         )
       end
 
       def decompress!
-        ::ActiveRecord::Base.connection.execute(
+        self.class.connection.execute(
           "SELECT decompress_chunk('#{chunk_full_name}')"
         )
       end
@@ -40,7 +40,7 @@ module Timescaledb
         options = ["'#{chunk_full_name}'"]
         options << "'#{index}'" if index.present?
 
-        ::ActiveRecord::Base.connection.execute(
+        self.class.connection.execute(
           "SELECT reorder_chunk(#{options.join(', ')})"
         )
       end

data/lib/timescaledb/rails/models/compression_setting.rb

@@ -3,7 +3,7 @@
 module Timescaledb
   module Rails
     # :nodoc:
-    class CompressionSetting < ::ActiveRecord::Base
+    class CompressionSetting < ApplicationRecord
       self.table_name = 'timescaledb_information.compression_settings'
       self.primary_key = 'hypertable_name'
 

data/lib/timescaledb/rails/models/concerns/durationable.rb

@@ -11,6 +11,8 @@ module Timescaledb
 
         # @return [String]
         def parse_duration(duration)
+          return if duration.nil?
+
           duration_in_seconds = duration_in_seconds(duration)
 
           duration_to_interval(

data/lib/timescaledb/rails/models/continuous_aggregate.rb

@@ -5,7 +5,7 @@ require 'timescaledb/rails/models/concerns/durationable'
 module Timescaledb
   module Rails
     # :nodoc:
-    class ContinuousAggregate < ::ActiveRecord::Base
+    class ContinuousAggregate < ApplicationRecord
       include Timescaledb::Rails::Models::Durationable
 
       self.table_name = 'timescaledb_information.continuous_aggregates'
@@ -13,13 +13,22 @@ module Timescaledb
 
       has_many :jobs, foreign_key: 'hypertable_name', class_name: 'Timescaledb::Rails::Job'
 
+      def self.dependency_ordered
+        deps = find_each.index_by(&:materialization_hypertable_name)
+
+        TSort.tsort_each(
+          ->(&b) { deps.each_value.sort_by(&:hypertable_name).each(&b) },
+          ->(n, &b) { Array.wrap(deps[n.hypertable_name]).each(&b) }
+        )
+      end
+
       # Manually refresh a continuous aggregate.
       #
       # @param [DateTime] start_time
       # @param [DateTime] end_time
       #
       def refresh!(start_time = 'NULL', end_time = 'NULL')
-        ::ActiveRecord::Base.connection.execute(
+        self.class.connection.execute(
           "CALL refresh_continuous_aggregate('#{view_name}', #{start_time}, #{end_time});"
         )
       end

data/lib/timescaledb/rails/models/dimension.rb

@@ -3,7 +3,7 @@
 module Timescaledb
   module Rails
     # :nodoc:
-    class Dimension < ::ActiveRecord::Base
+    class Dimension < ApplicationRecord
       TIME_TYPE = 'Time'
 
       self.table_name = 'timescaledb_information.dimensions'

data/lib/timescaledb/rails/models/hypertable.rb

@@ -5,7 +5,7 @@ require 'timescaledb/rails/models/concerns/durationable'
 module Timescaledb
   module Rails
     # :nodoc:
-    class Hypertable < ::ActiveRecord::Base
+    class Hypertable < ApplicationRecord
       include Timescaledb::Rails::Models::Durationable
 
       self.table_name = 'timescaledb_information.hypertables'
@@ -57,10 +57,15 @@ module Timescaledb
       end
 
       # @return [Boolean]
-      def compression?
+      def compression_policy?
         compression_job.present?
       end
 
+      # @return [Boolean]
+      def compression?
+        compression_settings.any?
+      end
+
       # @return [Boolean]
       def reorder?
         reorder_job.present?

data/lib/timescaledb/rails/models/job.rb

@@ -3,7 +3,7 @@
 module Timescaledb
   module Rails
     # :nodoc:
-    class Job < ::ActiveRecord::Base
+    class Job < ApplicationRecord
       self.table_name = 'timescaledb_information.jobs'
       self.primary_key = 'hypertable_name'
 

data/lib/timescaledb/rails/models.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative './models/application_record'
+
 require_relative './models/chunk'
 require_relative './models/compression_setting'
 require_relative './models/continuous_aggregate'

data/lib/timescaledb/rails/version.rb

@@ -3,6 +3,6 @@
 module Timescaledb
   # :nodoc:
   module Rails
-    VERSION = '0.1.5'
+    VERSION = '0.1.6'
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: timescaledb-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Iván Etchart
 - Santiago Doldán
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-24 00:00:00.000000000 Z
+date: 2023-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -123,7 +123,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.15'
-description: 
+description:
 email: oss@crunchloop.io
 executables: []
 extensions: []
@@ -144,6 +144,7 @@ files:
 - lib/timescaledb/rails/model/hyperfunctions.rb
 - lib/timescaledb/rails/model/scopes.rb
 - lib/timescaledb/rails/models.rb
+- lib/timescaledb/rails/models/application_record.rb
 - lib/timescaledb/rails/models/chunk.rb
 - lib/timescaledb/rails/models/compression_setting.rb
 - lib/timescaledb/rails/models/concerns/durationable.rb
@@ -159,7 +160,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -174,8 +175,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: TimescaleDB Rails integration
 test_files: []