Merge pull request #128 from stevehill1981/fix/remove-finalized-parameter-from-schema-dump

Remove finalized parameter from schema dump and CREATE statement

Author: josesahad

lib/timescaledb/migration_helpers.rb

@@ -84,7 +84,9 @@ def create_hypertable(table_name,
     # @option refresh_policies [String] schedule_interval: INTERVAL
     # @option materialized_only [Boolean] Override the WITH clause 'timescaledb.materialized_only'
     # @option create_group_indexes [Boolean] Override the WITH clause 'timescaledb.create_group_indexes'
-    # @option finalized [Boolean] Override the WITH clause 'timescaledb.finalized'
+    # @option finalized [Boolean] Set to false for legacy (non-finalized) format. Note: the finalized
+    #   parameter was removed in TimescaleDB 2.14+ where all aggregates are finalized by default.
+    #   Only use finalized: false on TimescaleDB 2.7-2.13 for legacy compatibility.
     #
     # @see https://docs.timescale.com/api/latest/continuous-aggregates/create_materialized_view/
     # @see https://docs.timescale.com/api/latest/continuous-aggregates/add_continuous_aggregate_policy/
@@ -99,13 +101,17 @@ def create_hypertable(table_name,
     #   SQL
     #
     def create_continuous_aggregate(table_name, query, **options)
+      # Only include finalized when explicitly false (legacy format).
+      # The parameter was removed in TimescaleDB 2.14+ where all aggregates are finalized by default.
+      finalized_clause = options[:finalized] == false ? ",timescaledb.finalized=false" : ""
+
       execute <<~SQL
         CREATE MATERIALIZED VIEW #{table_name}
         WITH (
           timescaledb.continuous
           #{build_with_clause_option_string(:materialized_only, options)}
           #{build_with_clause_option_string(:create_group_indexes, options)}
-          #{build_with_clause_option_string(:finalized, options)}
+          #{finalized_clause}
         ) AS
         #{query.respond_to?(:to_sql) ? query.to_sql : query}
         WITH #{'NO' unless options[:with_data]} DATA;

lib/timescaledb/schema_dumper.rb

@@ -162,7 +162,10 @@ def timescale_continuous_aggregates(stream)
           ""
         end
 
-        with_clause_opts = "materialized_only: #{aggregate[:materialized_only]}, finalized: #{aggregate[:finalized]}"
+        # Only output finalized when false (legacy format) - the parameter was
+        # removed in TimescaleDB 2.14+ where all aggregates are finalized by default
+        with_clause_opts = "materialized_only: #{aggregate[:materialized_only]}"
+        with_clause_opts += ", finalized: false" if aggregate[:finalized] == false
         stream.puts <<~AGG.indent(2)
           create_continuous_aggregate("#{aggregate.view_name}", <<-SQL, #{refresh_policies_opts}#{with_clause_opts})
             #{aggregate.view_definition.strip.gsub(/;$/, '')}

spec/timescaledb/migration_helper_spec.rb

@@ -136,8 +136,7 @@
       let(:options) do
         {
           materialized_only: true,
-          create_group_indexes: true,
-          finalized: true
+          create_group_indexes: true
         }
       end
 
@@ -178,15 +177,32 @@
       end
 
       context 'when overriding WITH clause timescaledb.finalized' do
+        # finalized: true is no longer output (deprecated in TimescaleDB 2.14+)
+        # Only finalized: false is output for legacy compatibility with 2.7-2.13
         let(:options) do
           {
-            finalized: true
+            finalized: false
           }
         end
 
         specify do
+          skip "TimescaleDB 2.14+ no longer supports partial (non-finalized) continuous aggregates" if Gem::Version.new(Timescaledb.extension.version) >= Gem::Version.new("2.14")
+
+          create_caggs
+          expect(ActiveRecord::Base.connection).to have_received(:execute).with(include('timescaledb.finalized=false'))
+        end
+      end
+
+      context 'when finalized: true (default)' do
+        let(:options) do
+          {
+            finalized: true
+          }
+        end
+
+        specify 'does not include finalized parameter' do
           create_caggs
-          expect(ActiveRecord::Base.connection).to have_received(:execute).with(include('timescaledb.finalized=true'))
+          expect(ActiveRecord::Base.connection).not_to have_received(:execute).with(include('timescaledb.finalized'))
         end
       end
     end

spec/timescaledb/schema_dumper_spec.rb

@@ -96,7 +96,9 @@
     dump = dump_output
 
     expect(dump).to include 'create_continuous_aggregate("event_counts"'
-    expect(dump).to include 'materialized_only: true, finalized: true'
+    # finalized: true is no longer output (deprecated in TimescaleDB 2.14+)
+    expect(dump).to include 'materialized_only: true'
+    expect(dump).not_to include 'finalized: true'
 
     expect(dump).not_to include ', ,'
     expect(dump).not_to include 'create_view "event_counts"' # Verify Scenic ignored this view