timescaledb-rails 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c8d3c2c06646deb35ad9d586965b9e4147504559734212b3f95168cb9db9e53
-  data.tar.gz: 6754f263db1dd6dcf3fad150de76bc6eb6cdc72958c68187fab4ee087d2b825f
+  metadata.gz: 2b682514201eb2e88a829297e9582cfe9513a127432de8acf7a060b769f38ca2
+  data.tar.gz: c30e268a3b9be19d95537230126a1c12c8aa97746afb3227f0e544293527d399
 SHA512:
-  metadata.gz: 806178772e4b1138ccce2b8e99ef8196e12b31023c339ba2383919c4f0eb199ce6d2f9af592411dd59c3c07a2dcc1a946a6bff8d926091d296693ba78af442b7
-  data.tar.gz: e92a57a816dee7069f65c9b68bb578b3bcef4670ae3f87e63f47420b26af2c9cc27cf011e49cece36c33ab9fd3f8deb0ce68794023f4a17f479672572716d4d4
+  metadata.gz: 1011081beb9b4a23ff4ceafe7b47278ad7418ace4438e3a67097e8db933802afd15875ba0a28f4141154ba12170bff7e4db28c4d8c5040d716c49f53b6c8d328
+  data.tar.gz: cd429d48862ce9dd82002fe35d3953814e893bd066a6e2143a9d5245036015d21b2b23174165389888225649e963a696a2328e0b5a228bf88efc268c39a5919e

data/README.md

@@ -60,6 +60,16 @@ class AddEventCompression < ActiveRecord::Migration[7.0]
 end
 ```
 
+Disable hypertable compression by doing:
+
+```ruby
+class RemoveEventCompression < ActiveRecord::Migration[7.0]
+  def change
+    remove_hypertable_compression :events
+  end
+end
+```
+
 ## Supported Ruby/Rails versions
 
 Supported Ruby/Rails versions are listed in [`.github/workflows/ci.yaml`](https://github.com/crunchloop/timescaledb-rails/blob/main/.github/workflows/ci.yaml)

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Timescaledb
+  module Rails
+    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 invert_create_hypertable(args, &block)
+          if block.nil?
+            raise ::ActiveRecord::IrreversibleMigration, 'create_hypertable is only reversible if given a block (can be empty).' # rubocop:disable Layout/LineLength
+          end
+
+          [:drop_table, args.first, block]
+        end
+
+        def invert_add_hypertable_compression(args, &block)
+          [:remove_hypertable_compression, args, block]
+        end
+
+        def invert_remove_hypertable_compression(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
+          end
+
+          [:add_hypertable_compression, args, block]
+        end
+      end
+    end
+  end
+end

data/lib/timescaledb/rails/extensions/active_record/{database_tasks.rb → postgresql_database_tasks.rb}

@@ -7,9 +7,13 @@ module Timescaledb
   module Rails
     module ActiveRecord
       # :nodoc:
-      module DatabaseTasks
-        def structure_dump(filename, extra_flags)
-          super
+      module PostgreSQLDatabaseTasks
+        # @override
+        def structure_dump(filename, extra_flags) # rubocop:disable Metrics/MethodLength
+          extra_flags = Array(extra_flags)
+          extra_flags << timescale_structure_dump_default_flags if timescale_enabled?
+
+          super(filename, extra_flags)
 
           return unless timescale_enabled?
 
@@ -46,7 +50,7 @@ module Timescaledb
 
         def hypertable_options(hypertable)
           sql_statements = ["if_not_exists => 'TRUE'"]
-          sql_statements << "chunk_time_interval => INTERVAL '#{hypertable.chunk_time_interval.inspect}'"
+          sql_statements << "chunk_time_interval => INTERVAL '#{hypertable.chunk_time_interval}'"
 
           sql_statements.compact.join(', ')
         end
@@ -68,6 +72,14 @@ module Timescaledb
           sql_statements.join(', ')
         end
 
+        # Returns `pg_dump` flag to exclude `_timescaledb_internal` schema tables.
+        #
+        # @return [String]
+        def timescale_structure_dump_default_flags
+          '--exclude-schema=_timescaledb_internal'
+        end
+
+        # @return [Boolean]
         def timescale_enabled?
           Timescaledb::Rails::Hypertable.table_exists?
         end

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

@@ -41,6 +41,15 @@ module Timescaledb
           execute "SELECT add_compression_policy('#{table_name}', INTERVAL '#{compress_after}')"
         end
 
+        # Disables compression from given table.
+        #
+        #   remove_hypertable_compression('events')
+        #
+        def remove_hypertable_compression(table_name, compress_after = nil, segment_by: nil, order_by: nil) # rubocop:disable Lint/UnusedMethodArgument
+          execute "SELECT remove_compression_policy('#{table_name}');"
+        end
+
+        # @return [String]
         def hypertable_options_to_sql(options)
           sql_statements = options.map do |option, value|
             case option

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

@@ -19,7 +19,9 @@ module Timescaledb
 
       # @return [String]
       def chunk_time_interval
-        time_dimension.time_interval
+        interval = time_dimension.time_interval
+
+        interval.is_a?(String) ? interval : interval.inspect
       end
 
       # @return [String]

data/lib/timescaledb/rails/railtie.rb

@@ -2,7 +2,8 @@
 
 require 'rails'
 
-require_relative 'extensions/active_record/database_tasks'
+require_relative 'extensions/active_record/command_recorder'
+require_relative 'extensions/active_record/postgresql_database_tasks'
 require_relative 'extensions/active_record/schema_dumper'
 require_relative 'extensions/active_record/schema_statements'
 
@@ -18,8 +19,12 @@ module Timescaledb
 
       initializer 'timescaledb-rails.add_timescale_support_to_active_record' do
         ActiveSupport.on_load(:active_record) do
+          ::ActiveRecord::Migration::CommandRecorder.prepend(
+            Timescaledb::Rails::ActiveRecord::CommandRecorder
+          )
+
           ::ActiveRecord::Tasks::PostgreSQLDatabaseTasks.prepend(
-            Timescaledb::Rails::ActiveRecord::DatabaseTasks
+            Timescaledb::Rails::ActiveRecord::PostgreSQLDatabaseTasks
           )
 
           ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend(

data/lib/timescaledb/rails/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timescaledb-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Iván Etchart
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-22 00:00:00.000000000 Z
+date: 2022-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -119,7 +119,8 @@ files:
 - README.md
 - lib/timescaledb-rails.rb
 - lib/timescaledb/rails.rb
-- lib/timescaledb/rails/extensions/active_record/database_tasks.rb
+- lib/timescaledb/rails/extensions/active_record/command_recorder.rb
+- lib/timescaledb/rails/extensions/active_record/postgresql_database_tasks.rb
 - lib/timescaledb/rails/extensions/active_record/schema_dumper.rb
 - lib/timescaledb/rails/extensions/active_record/schema_statements.rb
 - lib/timescaledb/rails/models.rb