Module: Switchman::ActiveRecord::Relation

Defined in:
lib/switchman/active_record/relation.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.prepended(klass) ⇒ Object 



6
7
8
 
# File 'lib/switchman/active_record/relation.rb', line 6

def self.prepended(klass)
  klass::SINGLE_VALUE_METHODS.push(:shard, :shard_source)
end

Instance Method Details

#activate(unordered: false, &block) ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/switchman/active_record/relation.rb', line 113

def activate(unordered: false, &block)
  shards = all_shards
  if Array === shards && shards.length == 1
    if !loaded? && shard_value != shards.first
      shard(shards.first).activate(&block)
    elsif shards.first == DefaultShard || shards.first == Shard.current(klass.connection_class_for_self)
      yield(self, shards.first)
    else
      shards.first.activate(klass.connection_class_for_self) { yield(self, shards.first) }
    end
  else
    result_count = 0
    can_order = false
    result = Shard.with_each_shard(shards, [klass.connection_class_for_self]) do
      # don't even query other shards if we're already past the limit
      next if limit_value && result_count >= limit_value && order_values.empty?

      relation = shard(Shard.current(klass.connection_class_for_self))
      relation.remove_nonlocal_primary_keys!
      # do a minimal query if possible
      if limit_value && !result_count.zero? && order_values.empty?
        relation = relation.limit(limit_value - result_count)
      end

      shard_results = relation.activate(&block)

      if shard_results.present? && !unordered
        can_order ||= can_order_cross_shard_results? unless order_values.empty?
        raise OrderOnMultiShardQuery if !can_order && !order_values.empty? && result_count.positive?

        result_count += shard_results.is_a?(Array) ? shard_results.length : 1
      end
      shard_results
    end

    result = reorder_cross_shard_results(result) if can_order
    result.slice!(limit_value..-1) if limit_value
    result
  end
end

#can_order_cross_shard_results? ⇒ Boolean

Returns:

  • (Boolean) 


154
155
156
157
 
# File 'lib/switchman/active_record/relation.rb', line 154

def can_order_cross_shard_results?
  # we only presume to be able to post-sort the most basic of orderings
  order_values.all? { |ov| ov.is_a?(::Arel::Nodes::Ordering) && ov.expr.is_a?(::Arel::Attributes::Attribute) }
end

#clone ⇒ Object 



16
17
18
19
20
 
# File 'lib/switchman/active_record/relation.rb', line 16

def clone
  result = super
  result.shard_value = Shard.current(klass ? klass.connection_class_for_self : :primary) unless shard_value
  result
end

#create(&block) ⇒ Object 



35
36
37
 
# File 'lib/switchman/active_record/relation.rb', line 35

def create(*, &block)
  primary_shard.activate(klass.connection_class_for_self) { super }
end

#create!(&block) ⇒ Object 



39
40
41
 
# File 'lib/switchman/active_record/relation.rb', line 39

def create!(*, &block)
  primary_shard.activate(klass.connection_class_for_self) { super }
end

#explain(*args) ⇒ Object 



53
54
55
 
# File 'lib/switchman/active_record/relation.rb', line 53

def explain(*args)
  activate { |relation| relation.call_super(:explain, Relation, *args) }
end

#find_ids_in_ranges(options = {}) ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/switchman/active_record/relation.rb', line 76

def find_ids_in_ranges(options = {})
  is_integer = columns_hash[primary_key.to_s].type == :integer
  loose_mode = options[:loose] && is_integer
  # loose_mode: if we don't care about getting exactly batch_size ids in between
  # don't get the max - just get the min and add batch_size so we get that many _at most_
  values = loose_mode ? "MIN(id)" : "MIN(id), MAX(id)"

  batch_size = options[:batch_size].try(:to_i) || 1000
  quoted_primary_key =
    "#{klass.connection.quote_local_table_name(table_name)}.#{klass.connection.quote_column_name(primary_key)}"
  as_id = " AS id" unless primary_key == "id"
  subquery_scope = except(:select)
                   .select("#{quoted_primary_key}#{as_id}")
                   .reorder(primary_key.to_sym)
                   .limit(loose_mode ? 1 : batch_size)
  subquery_scope = subquery_scope.where("#{quoted_primary_key} <= ?", options[:end_at]) if options[:end_at]

  first_subquery_scope = if options[:start_at]
                           subquery_scope.where("#{quoted_primary_key} >= ?",
                                                options[:start_at])
                         else
                           subquery_scope
                         end

  ids = connection.select_rows("SELECT #{values} FROM (#{first_subquery_scope.to_sql}) AS subquery").first

  while ids.first.present?
    ids.map!(&:to_i) if is_integer
    ids << (ids.first + batch_size) if loose_mode

    yield(*ids)
    last_value = ids.last
    next_subquery_scope = subquery_scope.where(["#{quoted_primary_key}>?", last_value])
    ids = connection.select_rows("SELECT #{values} FROM (#{next_subquery_scope.to_sql}) AS subquery").first
  end
end

#initialize ⇒ Object 



10
11
12
13
14
 
# File 'lib/switchman/active_record/relation.rb', line 10

def initialize(*, **)
  super
  self.shard_value = Shard.current(klass ? klass.connection_class_for_self : :primary) unless shard_value
  self.shard_source_value = :implicit unless shard_source_value
end

#load(&block) ⇒ Object 



57
58
59
60
61
62
63
64
 
# File 'lib/switchman/active_record/relation.rb', line 57

def load(&block)
  if !loaded? || (::Rails.version >= "7.0" && scheduled?)
    @records = activate { |relation| relation.send(:exec_queries, &block) }
    @loaded = true
  end

  self
end

#merge ⇒ Object 



22
23
24
25
26
27
28
29
 
# File 'lib/switchman/active_record/relation.rb', line 22

def merge(*)
  relation = super
  if relation.shard_value != shard_value && relation.shard_source_value == :implicit
    relation.shard_value = shard_value
    relation.shard_source_value = shard_source_value
  end
  relation
end

#new(&block) ⇒ Object 



31
32
33
 
# File 'lib/switchman/active_record/relation.rb', line 31

def new(*, &block)
  primary_shard.activate(klass.connection_class_for_self) { super }
end

#reorder_cross_shard_results(results) ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/switchman/active_record/relation.rb', line 159

def reorder_cross_shard_results(results)
  results.sort! do |l, r|
    result = 0
    order_values.each do |ov|
      if l.is_a?(::ActiveRecord::Base)
        a = l.attribute(ov.expr.name)
        b = r.attribute(ov.expr.name)
      else
        a, b = l, r
      end
      next if a == b

      if a.nil? || b.nil?
        result = 1 if a.nil?
        result *= -1 if ov.is_a?(::Arel::Nodes::Descending)
      else
        result = a <=> b
      end

      result *= -1 if ov.is_a?(::Arel::Nodes::Descending)
      break unless result.zero?
    end
    result
  end
end

#to_sql ⇒ Object 



43
44
45
 
# File 'lib/switchman/active_record/relation.rb', line 43

def to_sql
  primary_shard.activate(klass.connection_class_for_self) { super }
end

#transaction ⇒ Object 



48
49
50
 
# File 'lib/switchman/active_record/relation.rb', line 48

def transaction(...)
  primary_shard.activate(klass.connection_class_for_self) { super }
end