Class: Switchman::DatabaseServer

Inherits:
Object
  • Object
show all
Defined in:
lib/switchman/database_server.rb

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id = nil, config = {}) ⇒ DatabaseServer

Returns a new instance of DatabaseServer.



84
85
86
87
88
89
 
# File 'lib/switchman/database_server.rb', line 84

def initialize(id = nil, config = {})
  @id = id
  @config = config.deep_symbolize_keys
  @configs = {}
  @roles = [:primary]
end

Class Attribute Details

.creating_new_shard ⇒ Object

Returns the value of attribute creating_new_shard.



10
11
12
 
# File 'lib/switchman/database_server.rb', line 10

def creating_new_shard
  @creating_new_shard
end

Instance Attribute Details

#id ⇒ Object

Returns the value of attribute id.



7
8
9
 
# File 'lib/switchman/database_server.rb', line 7

def id
  @id
end

#roles ⇒ Object (readonly)

Returns the value of attribute roles.



82
83
84
 
# File 'lib/switchman/database_server.rb', line 82

def roles
  @roles
end

Class Method Details

.all ⇒ Object 



12
13
14
 
# File 'lib/switchman/database_server.rb', line 12

def all
  database_servers.values
end

.all_roles ⇒ Object 



16
17
18
 
# File 'lib/switchman/database_server.rb', line 16

def all_roles
  @all_roles ||= all.map(&:roles).flatten.uniq
end

.create(settings = {}) ⇒ Object 



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

def create(settings = {})
  raise 'database servers should be set up in database.yml' unless ::Rails.env.test?

  id = settings[:id]
  unless id
    @id ||= 0
    @id += 1
    id = @id
  end
  server = DatabaseServer.new(id.to_s, settings)
  server.instance_variable_set(:@fake, true)
  database_servers[server.id] = server
  ::ActiveRecord::Base.configurations.configurations <<
    ::ActiveRecord::DatabaseConfigurations::HashConfig.new(::Rails.env, "#{server.id}/primary", settings)
  Shard.send(:initialize_sharding)
  server
end

.find(id_or_all) ⇒ Object 



20
21
22
23
24
25
 
# File 'lib/switchman/database_server.rb', line 20

def find(id_or_all)
  return all if id_or_all == :all
  return id_or_all.map { |id| database_servers[id || ::Rails.env] }.compact.uniq if id_or_all.is_a?(Array)

  database_servers[id_or_all || ::Rails.env]
end

.server_for_new_shard ⇒ Object 



45
46
47
48
49
50
 
# File 'lib/switchman/database_server.rb', line 45

def server_for_new_shard
  servers = all.select { |s| s.config[:open] }
  return find(nil) if servers.empty?

  servers[rand(servers.length)]
end

Instance Method Details

#cache_store ⇒ Object 



242
243
244
245
 
# File 'lib/switchman/database_server.rb', line 242

def cache_store
  @cache_store ||= Switchman.config[:cache_map][id] || Switchman.config[:cache_map][::Rails.env]
  @cache_store
end

#config(environment = :primary) ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/switchman/database_server.rb', line 115

def config(environment = :primary)
  @configs[environment] ||=
    case @config[environment]
    when Array
      @config[environment].map do |config|
        config = @config.merge((config || {}).symbolize_keys)
        # make sure GuardRail doesn't get any brilliant ideas about choosing the first possible server
        config.delete(environment)
        config
      end
    when Hash
      @config.merge(@config[environment])
    else
      @config
    end
end

#connects_to_hash ⇒ Object 



91
92
93
94
95
96
97
98
99
 
# File 'lib/switchman/database_server.rb', line 91

def connects_to_hash
  self.class.all_roles.to_h do |role|
    config_role = role
    config_role = :primary unless roles.include?(role)
    config_name = :"#{id}/#{config_role}"
    config_name = :primary if id == ::Rails.env && config_role == :primary
    [role.to_sym, config_name]
  end
end

#create_new_shard(id: nil, name: nil, schema: true) ⇒ Object 



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/switchman/database_server.rb', line 163

def create_new_shard(id: nil, name: nil, schema: true)
  unless Shard.default.is_a?(Shard)
    raise NotImplementedError,
          "Cannot create new shards when sharding isn't initialized"
  end

  create_statement = -> { "CREATE SCHEMA #{name}" }
  password = " PASSWORD #{::ActiveRecord::Base.connection.quote(config[:password])}" if config[:password]
  sharding_config = Switchman.config
  config_create_statement = sharding_config[config[:adapter]]&.[](:create_statement)
  config_create_statement ||= sharding_config[:create_statement]
  if config_create_statement
    create_commands = Array(config_create_statement).dup
    create_statement = lambda {
      create_commands.map { |statement| format(statement, name: name, password: password) }
    }
  end

  id ||= begin
    id_seq = Shard.connection.quote(Shard.connection.quote_table_name('switchman_shards_id_seq'))
    next_id = Shard.connection.select_value("SELECT nextval(#{id_seq})")
    next_id.to_i
  end

  name ||= "#{config[:database]}_shard_#{id}"

  schema_already_existed = false
  shard = nil
  Shard.connection.transaction do
    self.class.creating_new_shard = true
    DatabaseServer.send(:reference_role, :deploy)
    ::ActiveRecord::Base.connected_to(shard: self.id.to_sym, role: :deploy) do
      shard = Shard.create!(id: id,
                            name: name,
                            database_server_id: self.id)
      if create_statement
        if ::ActiveRecord::Base.connection.select_value("SELECT 1 FROM pg_namespace WHERE nspname=#{::ActiveRecord::Base.connection.quote(name)}")
          schema_already_existed = true
          raise 'This schema already exists; cannot overwrite'
        end
        Array(create_statement.call).each do |stmt|
          ::ActiveRecord::Base.connection.execute(stmt)
        end
      end
      if config[:adapter] == 'postgresql'
        old_proc = ::ActiveRecord::Base.connection.raw_connection.set_notice_processor do
        end
      end
      old_verbose = ::ActiveRecord::Migration.verbose
      ::ActiveRecord::Migration.verbose = false

      unless schema == false
        shard.activate do
          reset_column_information

          ::ActiveRecord::Base.connection.transaction(requires_new: true) do
            ::ActiveRecord::Base.connection.migration_context.migrate
          end
          reset_column_information
          ::ActiveRecord::Base.descendants.reject do |m|
            m <= UnshardedRecord || !m.table_exists?
          end.each(&:define_attribute_methods)
        end
      end
    ensure
      ::ActiveRecord::Migration.verbose = old_verbose
      ::ActiveRecord::Base.connection.raw_connection.set_notice_processor(&old_proc) if old_proc
    end
    shard
  rescue
    shard&.destroy
    shard&.drop_database rescue nil unless schema_already_existed
    reset_column_information unless schema == false rescue nil
    raise
  ensure
    self.class.creating_new_shard = false
  end
end

#destroy ⇒ Object 



101
102
103
104
105
106
107
108
109
 
# File 'lib/switchman/database_server.rb', line 101

def destroy
  self.class.send(:database_servers).delete(id) if id
  Shard.sharded_models.each do |klass|
    self.class.all_roles.each do |role|
      klass.connection_handler.remove_connection_pool(klass.connection_specification_name, role: role,
                                                                                           shard: id.to_sym)
    end
  end
end

#fake? ⇒ Boolean

Returns:

  • (Boolean) 


111
112
113
 
# File 'lib/switchman/database_server.rb', line 111

def fake?
  @fake
end

#guard!(environment = :secondary) ⇒ Object

locks this db to a specific environment, except for when doing writes (then it falls back to the current value of GuardRail.environment)



139
140
141
 
# File 'lib/switchman/database_server.rb', line 139

def guard!(environment = :secondary)
  @guard_rail_environment = environment
end

#guard_rail_environment ⇒ Object 



132
133
134
 
# File 'lib/switchman/database_server.rb', line 132

def guard_rail_environment
  @guard_rail_environment || ::GuardRail.environment
end

#primary_shard ⇒ Object 



259
260
261
262
263
264
265
266
 
# File 'lib/switchman/database_server.rb', line 259

def primary_shard
  unless instance_variable_defined?(:@primary_shard)
    # if sharding isn't fully set up yet, we may not be able to query the shards table
    @primary_shard = Shard.default if Shard.default.database_server == self
    @primary_shard ||= shards.where(name: nil).first
  end
  @primary_shard
end

#shard_name(shard) ⇒ Object 



247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/switchman/database_server.rb', line 247

def shard_name(shard)
  return config[:shard_name] if config[:shard_name]

  if shard == :bootstrap
    # rescue nil because the database may not exist yet; if it doesn't,
    # it will shortly, and this will be re-invoked
    ::ActiveRecord::Base.connection.current_schemas.first rescue nil
  else
    shard.activate { ::ActiveRecord::Base.connection_pool.default_schema }
  end
end

#shards ⇒ Object 



155
156
157
158
159
160
161
 
# File 'lib/switchman/database_server.rb', line 155

def shards
  if id == ::Rails.env
    Shard.where('database_server_id IS NULL OR database_server_id=?', id)
  else
    Shard.where(database_server_id: id)
  end
end

#unguard ⇒ Object 



147
148
149
150
151
152
153
 
# File 'lib/switchman/database_server.rb', line 147

def unguard
  old_env = @guard_rail_environment
  unguard!
  yield
ensure
  guard!(old_env)
end

#unguard! ⇒ Object 



143
144
145
 
# File 'lib/switchman/database_server.rb', line 143

def unguard!
  @guard_rail_environment = nil
end