timescaledb 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5f8ebd4460e965fbf9a35600630c05d476b1a4b674192cd925a3d5f948a64a1
-  data.tar.gz: d697ab124689a8c4f1ffc5b809a7cecd2ac07bbce84c7b9ca539dc5ae67068c9
+  metadata.gz: f5cb8809c9bfe578eca1fc5fd3e5d6f93a3ff7eaa9a82f6f343d6258aa591817
+  data.tar.gz: 790728e08291b9df8539e08c37639bf81e8669df4e9321bc494cb27b25a21e81
 SHA512:
-  metadata.gz: 1070bf2f732137006d81790ac1c4b467f733edd3bb724e8773d3c9f6ecb3b5c1dc32c3da638f351589fa944a48c1b8f7a037da6a896beed1557e4fb34e2a8442
-  data.tar.gz: f5bc47e8c0022d079189e7ad68e2214da6760c4f420bca3c83950137dd7026985fb9239924c241b28f261546a860c744a32db154548bfc0f8871302d35109ff7
+  metadata.gz: 61deae5c4a9884e56595771fbbd5de843bc4b06b395bd119495193c5de5a9eb66087453d749d940223e79bfccd5703def5c829f9737385ebd414460782ef5340
+  data.tar.gz: fbd19b66f8d35af8995c25335bd001b92218acf30032533bd5972dff1bfed76105053c99c680ae705d67b6c87c8149c7426daa49de4913a58cc8d2b62327e442

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    timescaledb (0.2.4)
+    timescaledb (0.2.5)
       activerecord
       activesupport
       pg (~> 1.2)

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/schema_dumper.rb

@@ -21,15 +21,15 @@ module Timescaledb
     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 +39,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)
@@ -70,6 +75,22 @@ module Timescaledb
       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)
       Timescaledb::ContinuousAggregates.all.each do |aggregate|
         opts = if (refresh_policy = aggregate.jobs.refresh_continuous_aggregate.first)
@@ -95,6 +116,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.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timescaledb
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Jônatas Davi Paganini
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-16 00:00:00.000000000 Z
+date: 2022-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg