timescaledb 0.2.8 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 240bc1a55d3955c734d79946868b5e878cacfa354f7b0a843b72f78c26a85c83
-  data.tar.gz: 23ccc7e91c0da1ea522e5c8a71cd4522478aa1c73ff0e9ee6f61e42b26f9955c
+  metadata.gz: a20c2f12a3673694b39fd99aa005d743bbc027031d3abc7c25fda904f71ee33f
+  data.tar.gz: fd27816a15c114baa3d75a08bd083de5493efd7ce60ebe200d6543a3dcb266bf
 SHA512:
-  metadata.gz: 3ae2cda69cc099ad24a47aa4125ee10db96eb8186e261125f1e56ad6f4f2d805888d02d9eee92d48d18eab49d628918fef4e33234edc48ddb4ecb402d4518207
-  data.tar.gz: 65ee70a4b17944880979e71d1abee756a5f398f48cb048b575afbe4a0412f91d993ec97723c2b10d472ceafd405d7d013480824702c2a5db11e23f6eacb7f69a
+  metadata.gz: db6642dbdb2588359fc63fff080f34479725cef75d7972f081aa2a1beb680314cf1555ba7ec94956d16cceb3ac3b7724de131e010ba1d06361350f162ed3250c
+  data.tar.gz: df04ac079954e4b815d922d2a076929e6c4d5f5e9c11d46a54287138e8485fb171b276361a3bae43618c068709fa9f07c0ec34faa88c3afff18ac9d65d511766

data/lib/timescaledb/acts_as_hypertable.rb

@@ -62,4 +62,3 @@ module Timescaledb
   end
 end
 
-ActiveRecord::Base.extend Timescaledb::ActsAsHypertable

data/lib/timescaledb/connection.rb

@@ -1,6 +1,11 @@
 require 'singleton'
 
 module Timescaledb
+  # Minimal connection setup for Timescaledb directly with the PG.
+  # The concept is use a singleton component that can query
+  # independently of the ActiveRecord::Base connections.
+  # This is useful for the extension and hypertable metadata.
+  # It can also #use_connection from active record if needed.
   class Connection
     include Singleton
 
@@ -34,10 +39,16 @@ module Timescaledb
       !@config.nil?
     end
 
+    # Override the connection with a raw PG connection.
+    # @param [PG::Connection] connection The raw PG connection.
+    def use_connection connection
+      @connection = connection
+    end
+
     private
 
     def connection
       @connection ||= PG.connect(@config)
     end
   end
-end
+end

data/lib/timescaledb/connection_handling.rb

@@ -1,16 +1,21 @@
 module Timescaledb
   class ConnectionNotEstablishedError < StandardError; end
 
-  # @param [String] config The postgres connection string.
+  module_function
+  
+  # @param [String] config with the postgres connection string.
   def establish_connection(config)
     Connection.instance.config = config
   end
-  module_function :establish_connection
+
+  # @param [PG::Connection] to use it directly from a raw connection
+  def use_connection conn
+    Connection.instance.use_connection conn
+  end
 
   def connection
     raise ConnectionNotEstablishedError.new unless Connection.instance.connected?
 
     Connection.instance
   end
-  module_function :connection
-end
+end

data/lib/timescaledb/continuous_aggregates.rb

@@ -14,6 +14,30 @@ module Timescaledb
         total: count
       }
     end
+
+    scope :hierarchical, -> do
+      with_recursive = <<~SQL
+        WITH RECURSIVE caggs AS (
+          SELECT mat_hypertable_id, parent_mat_hypertable_id, user_view_name
+            FROM _timescaledb_catalog.continuous_agg
+          UNION ALL
+          SELECT continuous_agg.mat_hypertable_id, continuous_agg.parent_mat_hypertable_id, continuous_agg.user_view_name
+            FROM _timescaledb_catalog.continuous_agg
+        JOIN caggs ON caggs.parent_mat_hypertable_id = continuous_agg.mat_hypertable_id
+        )
+        SELECT * FROM caggs
+        ORDER BY mat_hypertable_id
+      SQL
+      views = unscoped
+        .select("distinct user_view_name")
+        .from("(#{with_recursive}) as caggs")
+        .pluck(:user_view_name)
+        .uniq
+
+      views.map do |view|
+        find_by(view_name: view)
+      end
+    end
   end
   ContinuousAggregates = ContinuousAggregate
 end

data/lib/timescaledb/extension.rb

@@ -0,0 +1,23 @@
+module Timescaledb
+
+  # Provides metadata around the extension in the database
+  module Extension
+    module_function
+    # @return String version of the timescaledb extension
+    def version
+      @version ||= Timescaledb.connection.query_first(<<~SQL)&.version
+        SELECT extversion as version
+        FROM pg_extension
+        WHERE extname = 'timescaledb'
+      SQL
+    end
+
+    def installed?
+      version.present?
+    end
+
+    def update!
+      Timescaledb.connection.execute('ALTER EXTENSION timescaledb UPDATE')
+    end
+  end
+end

data/lib/timescaledb/migration_helpers.rb

@@ -49,7 +49,7 @@ module Timescaledb
       original_logger = ActiveRecord::Base.logger
       ActiveRecord::Base.logger = Logger.new(STDOUT)
 
-      options = ["chunk_time_interval => INTERVAL '#{chunk_time_interval}'"]
+      options = ["chunk_time_interval => #{chunk_time_interval_clause(chunk_time_interval)}"]
       options += hypertable_options.map { |k, v| "#{k} => #{quote(v)}" }
 
       arguments = [
@@ -165,6 +165,14 @@ module Timescaledb
       value = options[option_key] ? 'true' : 'false'
       ",timescaledb.#{option_key}=#{value}"
     end
+
+    def chunk_time_interval_clause(chunk_time_interval)
+      if chunk_time_interval.is_a?(Numeric)
+        chunk_time_interval
+      else
+        "INTERVAL '#{chunk_time_interval}'"
+      end
+    end
   end
 end
 

data/lib/timescaledb/scenic/extension.rb

@@ -25,7 +25,6 @@ module Timescaledb
 
       # @override Scenic::Adapters::Postgres#create_view
       # to add the `with: ` keyword that can be used for such option.
-      #
       def create_view(name, version: nil, with: nil, sql_definition: nil, materialized: false, no_data: false)
         if version.present? && sql_definition.present?
           raise(
@@ -69,4 +68,4 @@ end
 
 
 Scenic::Adapters::Postgres.include(Timescaledb::Scenic::Extension)
-ActiveRecord::ConnectionAdapters::AbstractAdapter.include(Timescaledb::Scenic::MigrationHelpers)
+ActiveRecord::ConnectionAdapters::AbstractAdapter.prepend(Timescaledb::Scenic::MigrationHelpers)

data/lib/timescaledb/schema_dumper.rb

@@ -7,14 +7,29 @@ module Timescaledb
   # * retention policies
   # * continuous aggregates
   # * compression settings
+  # It also ignores Timescale related schemas when dumping the schema.
+  # It also ignores dumping options as extension is not installed or no hypertables are available.
   module SchemaDumper
     def tables(stream)
       super # This will call #table for each table in the database
-      return unless Timescaledb::Hypertable.table_exists?
 
-      timescale_hypertables(stream)
-      timescale_retention_policies(stream)
-      timescale_continuous_aggregates(stream) # Define these before any Scenic views that might use them
+      if exports_timescaledb_metadata?
+        timescale_hypertables(stream)
+        timescale_retention_policies(stream)
+        timescale_continuous_aggregates(stream) # Define these before any Scenic views that might use them
+      end
+    end
+
+    # Ignore dumps in case DB is not eligible for TimescaleDB metadata.
+    # @return [Boolean] true if the extension is installed and hypertables are available, otherwise false.
+    private def exports_timescaledb_metadata?
+      # Note it's safe to use the raw connection here because we're only reading from the database
+      # and not modifying it. We're also on the same connection pool as ActiveRecord::Base.
+      # The dump process also runs standalone, so we don't need to worry about the connection being
+      # used elsewhere.
+      Timescaledb.use_connection @connection.raw_connection
+
+      Timescaledb.extension.installed? && Timescaledb.hypertables.any?
     end
 
     # Ignores Timescale related schemas when dumping the schema
@@ -63,7 +78,7 @@ module Timescaledb
 
       options = {
         time_column: time.column_name,
-        chunk_time_interval: time.time_interval.inspect,
+        chunk_time_interval: time.time_interval ? time.time_interval.inspect : time.integer_interval,
         **timescale_compression_settings_for(hypertable),
         **timescale_space_partition_for(hypertable),
         **timescale_index_options_for(hypertable)
@@ -139,19 +154,19 @@ module Timescaledb
     def timescale_continuous_aggregates(stream)
       return unless Timescaledb::ContinuousAggregates.table_exists?
 
-      Timescaledb::ContinuousAggregates.all.find_each do |aggregate|
+      Timescaledb::ContinuousAggregates.hierarchical.each do |aggregate|
         refresh_policies_opts = if (refresh_policy = aggregate.jobs.refresh_continuous_aggregate.first)
           interval = timescale_interval(refresh_policy.schedule_interval)
           end_offset = timescale_interval(refresh_policy.config["end_offset"])
           start_offset = timescale_interval(refresh_policy.config["start_offset"])
-          %(refresh_policies: { start_offset: "#{start_offset}", end_offset: "#{end_offset}", schedule_interval: "#{interval}"})
+          %(refresh_policies: { start_offset: "#{start_offset}", end_offset: "#{end_offset}", schedule_interval: "#{interval}"}, )
         else
           ""
         end
 
         with_clause_opts = "materialized_only: #{aggregate[:materialized_only]}, finalized: #{aggregate[:finalized]}"
         stream.puts <<~AGG.indent(2)
-          create_continuous_aggregate("#{aggregate.view_name}", <<-SQL, #{refresh_policies_opts}, #{with_clause_opts})
+          create_continuous_aggregate("#{aggregate.view_name}", <<-SQL, #{refresh_policies_opts}#{with_clause_opts})
             #{aggregate.view_definition.strip.gsub(/;$/, '')}
           SQL
         AGG

data/lib/timescaledb/version.rb

@@ -1,3 +1,3 @@
 module Timescaledb
-  VERSION = '0.2.8'
+  VERSION = '0.3.0'
 end

data/lib/timescaledb.rb

@@ -17,11 +17,20 @@ require_relative 'timescaledb/schema_dumper'
 require_relative 'timescaledb/stats'
 require_relative 'timescaledb/stats_report'
 require_relative 'timescaledb/migration_helpers'
+require_relative 'timescaledb/extension'
 require_relative 'timescaledb/version'
 
 module Timescaledb
   module_function
 
+  def connection
+    Connection.instance
+  end
+
+  def extension
+    Extension
+  end
+
   def chunks
     Chunk.all
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timescaledb
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.3.0
 platform: ruby
 authors:
 - Jônatas Davi Paganini
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-30 00:00:00.000000000 Z
+date: 2024-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -163,6 +163,7 @@ files:
 - lib/timescaledb/database/schema_statements.rb
 - lib/timescaledb/database/types.rb
 - lib/timescaledb/dimensions.rb
+- lib/timescaledb/extension.rb
 - lib/timescaledb/hypertable.rb
 - lib/timescaledb/job.rb
 - lib/timescaledb/job_stats.rb