add settings to table dsl

Author: ezekg

lib/active_record/connection_adapters/clickhouse/schema_creation.rb

@@ -78,6 +78,13 @@ def add_ttl_clause!(create_sql, options)
           create_sql << " TTL #{ttl}"
         end
 
+        def add_settings_clause!(create_sql, options)
+          settings = options.respond_to?(:settings) ? options.settings : options[:settings]
+          return unless settings.present?
+
+          create_sql << " SETTINGS #{settings}"
+        end
+
         def add_as_clause!(create_sql, options)
           return unless options.as
 
@@ -132,6 +139,7 @@ def visit_TableDefinition(o)
           add_table_options!(create_sql, o) if !o.view || o.view && o.materialized && !o.to
           add_as_clause!(create_sql, o) if o.as && o.view
           add_ttl_clause!(create_sql, o) if o.ttl
+          add_settings_clause!(create_sql, o) if o.settings
           create_sql
         end
 

lib/active_record/connection_adapters/clickhouse/schema_statements.rb

@@ -157,7 +157,21 @@ def show_create_function(function)
 
         def table_options(table)
           sql = show_create_table(table)
-          { options: sql.gsub(/^(?:.*?)(?:ENGINE = (.*?))?( AS SELECT .*?)?$/, '\\1').presence, as: sql.match(/^CREATE (?:.*?) AS (SELECT .*?)$/).try(:[], 1) }.compact
+
+          as     = sql[/^CREATE .*? AS (SELECT .*?)$/m, 1]
+          engine = sql[/ENGINE = (.*?)(?: AS SELECT .*?)?$/m, 1]
+
+          return { as: }.compact unless engine.present?
+
+          engine, settings = extract_clause(engine, :settings)
+          engine, ttl      = extract_clause(engine, :ttl)
+
+          {
+            options: engine.presence,
+            ttl:,
+            settings:,
+            as:,
+          }.compact
         end
 
         # Not indexes on clickhouse
@@ -290,6 +304,18 @@ def has_default_function?(default) # :nodoc:
           (%r{\w+\(.*\)} === default)
         end
 
+        def extract_clause(source, clause)
+          pattern = /\s+#{clause.to_s.upcase}\s+(.+)$/im
+          match   = source.match(pattern)
+
+          return [source, nil] unless match.present?
+
+          [
+            source[0...match.begin(0)],
+            match[1].strip,
+          ]
+        end
+
         def raw_execute(sql, settings: {}, except_params: [])
           statement = Statement.new(sql, format: @response_format)
           response = request(statement, settings: settings, except_params: except_params)

lib/active_record/connection_adapters/clickhouse/table_definition.rb

@@ -5,7 +5,7 @@ module ConnectionAdapters
     module Clickhouse
       class TableDefinition < ActiveRecord::ConnectionAdapters::TableDefinition
 
-        attr_reader :view, :materialized, :if_not_exists, :to, :ttl
+        attr_reader :view, :materialized, :if_not_exists, :to, :ttl, :settings
 
         def initialize(
             conn,
@@ -19,6 +19,7 @@ def initialize(
             materialized: false,
             to: nil,
             ttl: nil,
+            settings: nil,
             **
           )
           @conn = conn
@@ -36,6 +37,7 @@ def initialize(
           @materialized = materialized
           @to = to
           @ttl = ttl
+          @settings = settings
         end
 
         def integer(*args, **options)

spec/fixtures/migrations/dsl_table_with_settings/1_create_some_table.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class CreateSomeTable < ActiveRecord::Migration[7.1]
+  def up
+    create_table :some, id: false, options: 'MergeTree ORDER BY an_id', ttl: 'date + INTERVAL 30 DAY', settings: 'allow_nullable_key = 1, index_granularity = 8192' do |t|
+      t.uuid :an_id, null: true
+      t.date :date, null: false
+      t.integer :data, null: false
+    end
+  end
+end

spec/single/migration_spec.rb

@@ -146,6 +146,7 @@
 
           context 'ttl' do
             let(:directory) { 'dsl_table_with_ttl' }
+
             it 'creates a table with table-level and column-level TTL' do
               subject
 
@@ -162,6 +163,63 @@
               create_sql = ActiveRecord::Base.connection.show_create_table('some')
               expect(create_sql).to include('TTL date + toIntervalDay(30)')
             end
+
+            it 'creates a table with TTL using correct statement order' do
+              subject
+
+              current_schema = schema(model)
+
+              # Verify TTL comes after ENGINE
+              create_sql = ActiveRecord::Base.connection.show_create_table('some')
+              engine_idx = create_sql.index('ENGINE = MergeTree')
+              ttl_idx = create_sql.index('TTL date + toIntervalDay(30)')
+              expect(engine_idx).to be < ttl_idx
+            end
+          end
+
+          context 'settings' do
+            let(:directory) { 'dsl_table_with_settings' }
+
+            it 'creates a table with table-level SETTINGS' do
+              subject
+
+              current_schema = schema(model)
+
+              expect(current_schema.keys.count).to eq(3)
+              expect(current_schema).to have_key('an_id')
+              expect(current_schema).to have_key('date')
+              expect(current_schema).to have_key('data')
+
+              # Verify table-level SETTINGS in SHOW CREATE TABLE
+              create_sql = ActiveRecord::Base.connection.show_create_table('some')
+              expect(create_sql).to include('SETTINGS allow_nullable_key = 1, index_granularity = 8192')
+            end
+
+            it 'creates a table with SETTINGS using correct statement order' do
+              subject
+
+              current_schema = schema(model)
+
+              # Verify TTL comes before SETTINGS
+              create_sql = ActiveRecord::Base.connection.show_create_table('some')
+              ttl_idx = create_sql.index('TTL date')
+              settings_idx = create_sql.index('SETTINGS')
+              expect(ttl_idx).to be < settings_idx
+            end
+
+            it 'dumps SETTINGS as separate option' do
+              require 'clickhouse-activerecord/schema_dumper'
+
+              subject
+
+              schema = StringIO.new
+              ClickhouseActiverecord::SchemaDumper.dump(ActiveRecord::Base.connection, schema)
+              schema_string = schema.string
+
+              expect(schema_string).to include('options: "MergeTree ORDER BY an_id"')
+              expect(schema_string).to include('ttl: "date + toIntervalDay(30)"')
+              expect(schema_string).to include('settings: "allow_nullable_key = 1, index_granularity = 8192"')
+            end
           end
 
           context 'datetime' do