Module: Gitlab::Database::DynamicModelHelpers

Included in:
BackgroundMigration::BackfillIssueSearchData, BackgroundMigration::BackfillMemberNamespaceForGroupMembers, BackgroundMigration::BackfillProjectSettings, BackgroundMigration::BatchedMigrationJob, BackgroundMigration::BatchingStrategies::LooseIndexScanBatchingStrategy, BackgroundMigration::BatchingStrategies::PrimaryKeyBatchingStrategy, BackgroundMigration::CleanupOrphanedRoutes, BackgroundOperation::BaseOperationWorker, Batch::Strategies::PrimaryKey, MigrationHelpers, Migrations::BatchedBackgroundMigrationHelpers, Migrations::TestBatchedBackgroundRunner
Defined in:
lib/gitlab/database/dynamic_model_helpers.rb

Constant Summary collapse

BATCH_SIZE = 
1_000

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.define_batchable_model(table_name, connection:, primary_key: nil, base_class: ActiveRecord::Base) ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/gitlab/database/dynamic_model_helpers.rb', line 8

def define_batchable_model(table_name, connection:, primary_key: nil, base_class: ActiveRecord::Base)
  klass = Class.new(base_class) do
    include EachBatch

    self.table_name = table_name
    self.inheritance_column = :_type_disabled

    # The method is used by ActiveRecord for its schema cache.
    # We need to override this to point to our given connection.
    def self.connection_pool
      connection.pool
    end
  end

  klass.primary_key = primary_key if connection.primary_keys(table_name).length > 1
  klass.connection = connection
  klass
end

Instance Method Details

#each_batch(table_name, connection:, scope: ->(table) { table.all }, of: BATCH_SIZE, **opts) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/gitlab/database/dynamic_model_helpers.rb', line 28

def each_batch(table_name, connection:, scope: ->(table) { table.all }, of: BATCH_SIZE, **opts)
  if transaction_open?
    raise <<~MSG.squish
      each_batch should not run inside a transaction, you can disable
      transactions by calling disable_ddl_transaction! in the body of
      your migration class
    MSG
  end

  opts.select! { |k, _| [:column].include? k }

  batchable_model = define_batchable_model(table_name, connection: connection)

  scope.call(batchable_model)
    .each_batch(of: of, **opts) { |batch| yield batch, batchable_model }
end

#each_batch_range(table_name, connection:, scope: ->(table) { table.all }, of: BATCH_SIZE, **opts) ⇒ Object 



45
46
47
48
49
50
51
52
53
 
# File 'lib/gitlab/database/dynamic_model_helpers.rb', line 45

def each_batch_range(table_name, connection:, scope: ->(table) { table.all }, of: BATCH_SIZE, **opts)
  opts.select! { |k, _| [:column].include? k }

  each_batch(table_name, connection: connection, scope: scope, of: of, **opts) do |batch, batchable_model|
    column = opts.fetch(:column, batchable_model.primary_key)

    yield batch.pick("MIN(#{column}), MAX(#{column})")
  end
end