activerecord 5.2.8.1 → 6.1.6.1
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of activerecord might be problematic. Click here for more details.
- checksums.yaml +4 -4
- data/CHANGELOG.md +1255 -596
- data/MIT-LICENSE +3 -1
- data/README.rdoc +7 -5
- data/examples/performance.rb +1 -1
- data/lib/active_record/aggregations.rb +9 -8
- data/lib/active_record/association_relation.rb +30 -10
- data/lib/active_record/associations/alias_tracker.rb +19 -16
- data/lib/active_record/associations/association.rb +100 -41
- data/lib/active_record/associations/association_scope.rb +23 -21
- data/lib/active_record/associations/belongs_to_association.rb +55 -48
- data/lib/active_record/associations/belongs_to_polymorphic_association.rb +7 -6
- data/lib/active_record/associations/builder/association.rb +45 -22
- data/lib/active_record/associations/builder/belongs_to.rb +29 -59
- data/lib/active_record/associations/builder/collection_association.rb +8 -17
- data/lib/active_record/associations/builder/has_and_belongs_to_many.rb +17 -41
- data/lib/active_record/associations/builder/has_many.rb +8 -2
- data/lib/active_record/associations/builder/has_one.rb +33 -2
- data/lib/active_record/associations/builder/singular_association.rb +3 -1
- data/lib/active_record/associations/collection_association.rb +44 -34
- data/lib/active_record/associations/collection_proxy.rb +25 -21
- data/lib/active_record/associations/foreign_association.rb +20 -0
- data/lib/active_record/associations/has_many_association.rb +26 -13
- data/lib/active_record/associations/has_many_through_association.rb +24 -18
- data/lib/active_record/associations/has_one_association.rb +43 -31
- data/lib/active_record/associations/has_one_through_association.rb +5 -5
- data/lib/active_record/associations/join_dependency/join_association.rb +44 -22
- data/lib/active_record/associations/join_dependency/join_part.rb +5 -5
- data/lib/active_record/associations/join_dependency.rb +91 -60
- data/lib/active_record/associations/preloader/association.rb +69 -43
- data/lib/active_record/associations/preloader/through_association.rb +49 -40
- data/lib/active_record/associations/preloader.rb +47 -34
- data/lib/active_record/associations/singular_association.rb +3 -17
- data/lib/active_record/associations/through_association.rb +1 -1
- data/lib/active_record/associations.rb +137 -25
- data/lib/active_record/attribute_assignment.rb +17 -19
- data/lib/active_record/attribute_methods/before_type_cast.rb +13 -7
- data/lib/active_record/attribute_methods/dirty.rb +101 -40
- data/lib/active_record/attribute_methods/primary_key.rb +20 -25
- data/lib/active_record/attribute_methods/query.rb +4 -8
- data/lib/active_record/attribute_methods/read.rb +14 -56
- data/lib/active_record/attribute_methods/serialization.rb +12 -7
- data/lib/active_record/attribute_methods/time_zone_conversion.rb +12 -15
- data/lib/active_record/attribute_methods/write.rb +18 -34
- data/lib/active_record/attribute_methods.rb +81 -143
- data/lib/active_record/attributes.rb +46 -9
- data/lib/active_record/autosave_association.rb +57 -42
- data/lib/active_record/base.rb +4 -17
- data/lib/active_record/callbacks.rb +158 -43
- data/lib/active_record/coders/yaml_column.rb +1 -2
- data/lib/active_record/connection_adapters/abstract/connection_pool.rb +272 -130
- data/lib/active_record/connection_adapters/abstract/database_limits.rb +7 -36
- data/lib/active_record/connection_adapters/abstract/database_statements.rb +167 -146
- data/lib/active_record/connection_adapters/abstract/query_cache.rb +18 -14
- data/lib/active_record/connection_adapters/abstract/quoting.rb +98 -47
- data/lib/active_record/connection_adapters/abstract/savepoints.rb +3 -3
- data/lib/active_record/connection_adapters/abstract/schema_creation.rb +153 -110
- data/lib/active_record/connection_adapters/abstract/schema_definitions.rb +211 -90
- data/lib/active_record/connection_adapters/abstract/schema_dumper.rb +2 -4
- data/lib/active_record/connection_adapters/abstract/schema_statements.rb +385 -144
- data/lib/active_record/connection_adapters/abstract/transaction.rb +167 -69
- data/lib/active_record/connection_adapters/abstract_adapter.rb +229 -99
- data/lib/active_record/connection_adapters/abstract_mysql_adapter.rb +243 -275
- data/lib/active_record/connection_adapters/column.rb +30 -12
- data/lib/active_record/connection_adapters/deduplicable.rb +29 -0
- data/lib/active_record/connection_adapters/legacy_pool_manager.rb +35 -0
- data/lib/active_record/connection_adapters/mysql/column.rb +1 -1
- data/lib/active_record/connection_adapters/mysql/database_statements.rb +88 -32
- data/lib/active_record/connection_adapters/mysql/explain_pretty_printer.rb +1 -2
- data/lib/active_record/connection_adapters/mysql/quoting.rb +59 -7
- data/lib/active_record/connection_adapters/mysql/schema_creation.rb +34 -10
- data/lib/active_record/connection_adapters/mysql/schema_definitions.rb +48 -32
- data/lib/active_record/connection_adapters/mysql/schema_dumper.rb +18 -7
- data/lib/active_record/connection_adapters/mysql/schema_statements.rb +142 -19
- data/lib/active_record/connection_adapters/mysql/type_metadata.rb +14 -9
- data/lib/active_record/connection_adapters/mysql2_adapter.rb +53 -18
- data/lib/active_record/connection_adapters/pool_config.rb +73 -0
- data/lib/active_record/connection_adapters/pool_manager.rb +47 -0
- data/lib/active_record/connection_adapters/postgresql/column.rb +37 -28
- data/lib/active_record/connection_adapters/postgresql/database_statements.rb +40 -54
- data/lib/active_record/connection_adapters/postgresql/oid/array.rb +1 -2
- data/lib/active_record/connection_adapters/postgresql/oid/bit.rb +1 -4
- data/lib/active_record/connection_adapters/postgresql/oid/cidr.rb +3 -5
- data/lib/active_record/connection_adapters/postgresql/oid/date.rb +2 -2
- data/lib/active_record/connection_adapters/postgresql/oid/date_time.rb +10 -2
- data/lib/active_record/connection_adapters/postgresql/oid/enum.rb +0 -1
- data/lib/active_record/connection_adapters/postgresql/oid/hstore.rb +1 -2
- data/lib/active_record/connection_adapters/postgresql/oid/interval.rb +49 -0
- data/lib/active_record/connection_adapters/postgresql/oid/legacy_point.rb +3 -4
- data/lib/active_record/connection_adapters/postgresql/oid/macaddr.rb +25 -0
- data/lib/active_record/connection_adapters/postgresql/oid/oid.rb +1 -1
- data/lib/active_record/connection_adapters/postgresql/oid/point.rb +3 -4
- data/lib/active_record/connection_adapters/postgresql/oid/range.rb +25 -7
- data/lib/active_record/connection_adapters/postgresql/oid/specialized_string.rb +1 -1
- data/lib/active_record/connection_adapters/postgresql/oid/type_map_initializer.rb +9 -7
- data/lib/active_record/connection_adapters/postgresql/oid/uuid.rb +15 -3
- data/lib/active_record/connection_adapters/postgresql/oid.rb +2 -0
- data/lib/active_record/connection_adapters/postgresql/quoting.rb +47 -10
- data/lib/active_record/connection_adapters/postgresql/referential_integrity.rb +2 -2
- data/lib/active_record/connection_adapters/postgresql/schema_creation.rb +19 -4
- data/lib/active_record/connection_adapters/postgresql/schema_definitions.rb +107 -91
- data/lib/active_record/connection_adapters/postgresql/schema_dumper.rb +0 -1
- data/lib/active_record/connection_adapters/postgresql/schema_statements.rb +120 -100
- data/lib/active_record/connection_adapters/postgresql/type_metadata.rb +31 -26
- data/lib/active_record/connection_adapters/postgresql/utils.rb +0 -1
- data/lib/active_record/connection_adapters/postgresql_adapter.rb +224 -120
- data/lib/active_record/connection_adapters/schema_cache.rb +159 -21
- data/lib/active_record/connection_adapters/sql_type_metadata.rb +17 -6
- data/lib/active_record/connection_adapters/sqlite3/database_statements.rb +146 -0
- data/lib/active_record/connection_adapters/sqlite3/quoting.rb +42 -7
- data/lib/active_record/connection_adapters/sqlite3/schema_creation.rb +5 -1
- data/lib/active_record/connection_adapters/sqlite3/schema_statements.rb +77 -13
- data/lib/active_record/connection_adapters/sqlite3_adapter.rb +174 -186
- data/lib/active_record/connection_adapters/statement_pool.rb +0 -1
- data/lib/active_record/connection_adapters.rb +52 -0
- data/lib/active_record/connection_handling.rb +293 -33
- data/lib/active_record/core.rb +333 -98
- data/lib/active_record/counter_cache.rb +8 -30
- data/lib/active_record/database_configurations/connection_url_resolver.rb +99 -0
- data/lib/active_record/database_configurations/database_config.rb +80 -0
- data/lib/active_record/database_configurations/hash_config.rb +96 -0
- data/lib/active_record/database_configurations/url_config.rb +53 -0
- data/lib/active_record/database_configurations.rb +273 -0
- data/lib/active_record/delegated_type.rb +209 -0
- data/lib/active_record/destroy_association_async_job.rb +36 -0
- data/lib/active_record/dynamic_matchers.rb +3 -4
- data/lib/active_record/enum.rb +108 -36
- data/lib/active_record/errors.rb +62 -19
- data/lib/active_record/explain.rb +10 -6
- data/lib/active_record/explain_subscriber.rb +1 -1
- data/lib/active_record/fixture_set/file.rb +10 -17
- data/lib/active_record/fixture_set/model_metadata.rb +32 -0
- data/lib/active_record/fixture_set/render_context.rb +17 -0
- data/lib/active_record/fixture_set/table_row.rb +152 -0
- data/lib/active_record/fixture_set/table_rows.rb +46 -0
- data/lib/active_record/fixtures.rb +200 -481
- data/lib/active_record/gem_version.rb +3 -3
- data/lib/active_record/inheritance.rb +53 -24
- data/lib/active_record/insert_all.rb +212 -0
- data/lib/active_record/integration.rb +67 -17
- data/lib/active_record/internal_metadata.rb +28 -9
- data/lib/active_record/legacy_yaml_adapter.rb +7 -3
- data/lib/active_record/locking/optimistic.rb +37 -23
- data/lib/active_record/locking/pessimistic.rb +9 -5
- data/lib/active_record/log_subscriber.rb +35 -35
- data/lib/active_record/middleware/database_selector/resolver/session.rb +48 -0
- data/lib/active_record/middleware/database_selector/resolver.rb +92 -0
- data/lib/active_record/middleware/database_selector.rb +77 -0
- data/lib/active_record/migration/command_recorder.rb +96 -44
- data/lib/active_record/migration/compatibility.rb +145 -64
- data/lib/active_record/migration/join_table.rb +0 -1
- data/lib/active_record/migration.rb +206 -157
- data/lib/active_record/model_schema.rb +148 -22
- data/lib/active_record/nested_attributes.rb +4 -7
- data/lib/active_record/no_touching.rb +8 -1
- data/lib/active_record/null_relation.rb +0 -1
- data/lib/active_record/persistence.rb +267 -59
- data/lib/active_record/query_cache.rb +21 -4
- data/lib/active_record/querying.rb +40 -23
- data/lib/active_record/railtie.rb +116 -59
- data/lib/active_record/railties/console_sandbox.rb +2 -4
- data/lib/active_record/railties/controller_runtime.rb +30 -35
- data/lib/active_record/railties/databases.rake +411 -80
- data/lib/active_record/readonly_attributes.rb +4 -0
- data/lib/active_record/reflection.rb +109 -93
- data/lib/active_record/relation/batches/batch_enumerator.rb +25 -9
- data/lib/active_record/relation/batches.rb +44 -35
- data/lib/active_record/relation/calculations.rb +157 -90
- data/lib/active_record/relation/delegation.rb +35 -50
- data/lib/active_record/relation/finder_methods.rb +64 -39
- data/lib/active_record/relation/from_clause.rb +5 -1
- data/lib/active_record/relation/merger.rb +32 -40
- data/lib/active_record/relation/predicate_builder/array_handler.rb +13 -13
- data/lib/active_record/relation/predicate_builder/association_query_value.rb +5 -9
- data/lib/active_record/relation/predicate_builder/basic_object_handler.rb +1 -2
- data/lib/active_record/relation/predicate_builder/polymorphic_array_value.rb +11 -10
- data/lib/active_record/relation/predicate_builder/range_handler.rb +3 -23
- data/lib/active_record/relation/predicate_builder/relation_handler.rb +1 -1
- data/lib/active_record/relation/predicate_builder.rb +62 -45
- data/lib/active_record/relation/query_attribute.rb +13 -8
- data/lib/active_record/relation/query_methods.rb +476 -187
- data/lib/active_record/relation/record_fetch_warning.rb +3 -3
- data/lib/active_record/relation/spawn_methods.rb +9 -9
- data/lib/active_record/relation/where_clause.rb +115 -62
- data/lib/active_record/relation.rb +379 -115
- data/lib/active_record/result.rb +64 -38
- data/lib/active_record/runtime_registry.rb +2 -2
- data/lib/active_record/sanitization.rb +22 -41
- data/lib/active_record/schema.rb +2 -11
- data/lib/active_record/schema_dumper.rb +54 -9
- data/lib/active_record/schema_migration.rb +7 -9
- data/lib/active_record/scoping/default.rb +4 -8
- data/lib/active_record/scoping/named.rb +17 -24
- data/lib/active_record/scoping.rb +8 -9
- data/lib/active_record/secure_token.rb +16 -8
- data/lib/active_record/serialization.rb +5 -3
- data/lib/active_record/signed_id.rb +116 -0
- data/lib/active_record/statement_cache.rb +49 -6
- data/lib/active_record/store.rb +88 -9
- data/lib/active_record/suppressor.rb +2 -2
- data/lib/active_record/table_metadata.rb +42 -43
- data/lib/active_record/tasks/database_tasks.rb +277 -81
- data/lib/active_record/tasks/mysql_database_tasks.rb +37 -39
- data/lib/active_record/tasks/postgresql_database_tasks.rb +27 -32
- data/lib/active_record/tasks/sqlite_database_tasks.rb +14 -17
- data/lib/active_record/test_databases.rb +24 -0
- data/lib/active_record/test_fixtures.rb +287 -0
- data/lib/active_record/timestamp.rb +43 -32
- data/lib/active_record/touch_later.rb +23 -22
- data/lib/active_record/transactions.rb +62 -118
- data/lib/active_record/translation.rb +1 -1
- data/lib/active_record/type/adapter_specific_registry.rb +3 -13
- data/lib/active_record/type/hash_lookup_type_map.rb +0 -1
- data/lib/active_record/type/serialized.rb +6 -3
- data/lib/active_record/type/time.rb +10 -0
- data/lib/active_record/type/type_map.rb +0 -1
- data/lib/active_record/type/unsigned_integer.rb +0 -1
- data/lib/active_record/type.rb +10 -5
- data/lib/active_record/type_caster/connection.rb +15 -15
- data/lib/active_record/type_caster/map.rb +8 -8
- data/lib/active_record/validations/associated.rb +1 -2
- data/lib/active_record/validations/numericality.rb +35 -0
- data/lib/active_record/validations/uniqueness.rb +38 -30
- data/lib/active_record/validations.rb +4 -3
- data/lib/active_record.rb +13 -12
- data/lib/arel/alias_predication.rb +9 -0
- data/lib/arel/attributes/attribute.rb +41 -0
- data/lib/arel/collectors/bind.rb +29 -0
- data/lib/arel/collectors/composite.rb +39 -0
- data/lib/arel/collectors/plain_string.rb +20 -0
- data/lib/arel/collectors/sql_string.rb +27 -0
- data/lib/arel/collectors/substitute_binds.rb +35 -0
- data/lib/arel/crud.rb +42 -0
- data/lib/arel/delete_manager.rb +18 -0
- data/lib/arel/errors.rb +9 -0
- data/lib/arel/expressions.rb +29 -0
- data/lib/arel/factory_methods.rb +49 -0
- data/lib/arel/insert_manager.rb +49 -0
- data/lib/arel/math.rb +45 -0
- data/lib/arel/nodes/and.rb +32 -0
- data/lib/arel/nodes/ascending.rb +23 -0
- data/lib/arel/nodes/binary.rb +126 -0
- data/lib/arel/nodes/bind_param.rb +44 -0
- data/lib/arel/nodes/case.rb +55 -0
- data/lib/arel/nodes/casted.rb +62 -0
- data/lib/arel/nodes/comment.rb +29 -0
- data/lib/arel/nodes/count.rb +12 -0
- data/lib/arel/nodes/delete_statement.rb +45 -0
- data/lib/arel/nodes/descending.rb +23 -0
- data/lib/arel/nodes/equality.rb +15 -0
- data/lib/arel/nodes/extract.rb +24 -0
- data/lib/arel/nodes/false.rb +16 -0
- data/lib/arel/nodes/full_outer_join.rb +8 -0
- data/lib/arel/nodes/function.rb +44 -0
- data/lib/arel/nodes/grouping.rb +11 -0
- data/lib/arel/nodes/homogeneous_in.rb +76 -0
- data/lib/arel/nodes/in.rb +15 -0
- data/lib/arel/nodes/infix_operation.rb +92 -0
- data/lib/arel/nodes/inner_join.rb +8 -0
- data/lib/arel/nodes/insert_statement.rb +37 -0
- data/lib/arel/nodes/join_source.rb +20 -0
- data/lib/arel/nodes/matches.rb +18 -0
- data/lib/arel/nodes/named_function.rb +23 -0
- data/lib/arel/nodes/node.rb +51 -0
- data/lib/arel/nodes/node_expression.rb +13 -0
- data/lib/arel/nodes/ordering.rb +27 -0
- data/lib/arel/nodes/outer_join.rb +8 -0
- data/lib/arel/nodes/over.rb +15 -0
- data/lib/arel/nodes/regexp.rb +16 -0
- data/lib/arel/nodes/right_outer_join.rb +8 -0
- data/lib/arel/nodes/select_core.rb +67 -0
- data/lib/arel/nodes/select_statement.rb +41 -0
- data/lib/arel/nodes/sql_literal.rb +19 -0
- data/lib/arel/nodes/string_join.rb +11 -0
- data/lib/arel/nodes/table_alias.rb +31 -0
- data/lib/arel/nodes/terminal.rb +16 -0
- data/lib/arel/nodes/true.rb +16 -0
- data/lib/arel/nodes/unary.rb +44 -0
- data/lib/arel/nodes/unary_operation.rb +20 -0
- data/lib/arel/nodes/unqualified_column.rb +22 -0
- data/lib/arel/nodes/update_statement.rb +41 -0
- data/lib/arel/nodes/values_list.rb +9 -0
- data/lib/arel/nodes/window.rb +126 -0
- data/lib/arel/nodes/with.rb +11 -0
- data/lib/arel/nodes.rb +70 -0
- data/lib/arel/order_predications.rb +13 -0
- data/lib/arel/predications.rb +250 -0
- data/lib/arel/select_manager.rb +270 -0
- data/lib/arel/table.rb +118 -0
- data/lib/arel/tree_manager.rb +72 -0
- data/lib/arel/update_manager.rb +34 -0
- data/lib/arel/visitors/dot.rb +308 -0
- data/lib/arel/visitors/mysql.rb +93 -0
- data/lib/arel/visitors/postgresql.rb +120 -0
- data/lib/arel/visitors/sqlite.rb +38 -0
- data/lib/arel/visitors/to_sql.rb +899 -0
- data/lib/arel/visitors/visitor.rb +45 -0
- data/lib/arel/visitors.rb +13 -0
- data/lib/arel/window_predications.rb +9 -0
- data/lib/arel.rb +54 -0
- data/lib/rails/generators/active_record/application_record/application_record_generator.rb +0 -1
- data/lib/rails/generators/active_record/migration/migration_generator.rb +3 -5
- data/lib/rails/generators/active_record/migration/templates/create_table_migration.rb.tt +3 -1
- data/lib/rails/generators/active_record/migration/templates/migration.rb.tt +7 -5
- data/lib/rails/generators/active_record/migration.rb +19 -2
- data/lib/rails/generators/active_record/model/model_generator.rb +39 -2
- data/lib/rails/generators/active_record/model/templates/abstract_base_class.rb.tt +7 -0
- data/lib/rails/generators/active_record/model/templates/model.rb.tt +10 -1
- metadata +116 -30
- data/lib/active_record/attribute_decorators.rb +0 -90
- data/lib/active_record/collection_cache_key.rb +0 -53
- data/lib/active_record/connection_adapters/connection_specification.rb +0 -287
- data/lib/active_record/connection_adapters/determine_if_preparable_visitor.rb +0 -33
- data/lib/active_record/define_callbacks.rb +0 -22
- data/lib/active_record/relation/predicate_builder/base_handler.rb +0 -19
- data/lib/active_record/relation/where_clause_factory.rb +0 -34
@@ -46,41 +46,234 @@ module ActiveRecord
|
|
46
46
|
#
|
47
47
|
# The exceptions AdapterNotSpecified, AdapterNotFound and +ArgumentError+
|
48
48
|
# may be returned on an error.
|
49
|
-
def establish_connection(
|
50
|
-
|
49
|
+
def establish_connection(config_or_env = nil)
|
50
|
+
config_or_env ||= DEFAULT_ENV.call.to_sym
|
51
|
+
db_config, owner_name = resolve_config_for_connection(config_or_env)
|
52
|
+
connection_handler.establish_connection(db_config, owner_name: owner_name, role: current_role, shard: current_shard)
|
53
|
+
end
|
54
|
+
|
55
|
+
# Connects a model to the databases specified. The +database+ keyword
|
56
|
+
# takes a hash consisting of a +role+ and a +database_key+.
|
57
|
+
#
|
58
|
+
# This will create a connection handler for switching between connections,
|
59
|
+
# look up the config hash using the +database_key+ and finally
|
60
|
+
# establishes a connection to that config.
|
61
|
+
#
|
62
|
+
# class AnimalsModel < ApplicationRecord
|
63
|
+
# self.abstract_class = true
|
64
|
+
#
|
65
|
+
# connects_to database: { writing: :primary, reading: :primary_replica }
|
66
|
+
# end
|
67
|
+
#
|
68
|
+
# +connects_to+ also supports horizontal sharding. The horizontal sharding API
|
69
|
+
# also supports read replicas. Connect a model to a list of shards like this:
|
70
|
+
#
|
71
|
+
# class AnimalsModel < ApplicationRecord
|
72
|
+
# self.abstract_class = true
|
73
|
+
#
|
74
|
+
# connects_to shards: {
|
75
|
+
# default: { writing: :primary, reading: :primary_replica },
|
76
|
+
# shard_two: { writing: :primary_shard_two, reading: :primary_shard_replica_two }
|
77
|
+
# }
|
78
|
+
# end
|
79
|
+
#
|
80
|
+
# Returns an array of database connections.
|
81
|
+
def connects_to(database: {}, shards: {})
|
82
|
+
raise NotImplementedError, "`connects_to` can only be called on ActiveRecord::Base or abstract classes" unless self == Base || abstract_class?
|
83
|
+
|
84
|
+
if database.present? && shards.present?
|
85
|
+
raise ArgumentError, "`connects_to` can only accept a `database` or `shards` argument, but not both arguments."
|
86
|
+
end
|
87
|
+
|
88
|
+
connections = []
|
89
|
+
|
90
|
+
database.each do |role, database_key|
|
91
|
+
db_config, owner_name = resolve_config_for_connection(database_key)
|
92
|
+
handler = lookup_connection_handler(role.to_sym)
|
93
|
+
|
94
|
+
self.connection_class = true
|
95
|
+
connections << handler.establish_connection(db_config, owner_name: owner_name, role: role)
|
96
|
+
end
|
97
|
+
|
98
|
+
shards.each do |shard, database_keys|
|
99
|
+
database_keys.each do |role, database_key|
|
100
|
+
db_config, owner_name = resolve_config_for_connection(database_key)
|
101
|
+
handler = lookup_connection_handler(role.to_sym)
|
102
|
+
|
103
|
+
self.connection_class = true
|
104
|
+
connections << handler.establish_connection(db_config, owner_name: owner_name, role: role, shard: shard.to_sym)
|
105
|
+
end
|
106
|
+
end
|
107
|
+
|
108
|
+
connections
|
109
|
+
end
|
110
|
+
|
111
|
+
# Connects to a role (ex writing, reading or a custom role) and/or
|
112
|
+
# shard for the duration of the block. At the end of the block the
|
113
|
+
# connection will be returned to the original role / shard.
|
114
|
+
#
|
115
|
+
# If only a role is passed, Active Record will look up the connection
|
116
|
+
# based on the requested role. If a non-established role is requested
|
117
|
+
# an +ActiveRecord::ConnectionNotEstablished+ error will be raised:
|
118
|
+
#
|
119
|
+
# ActiveRecord::Base.connected_to(role: :writing) do
|
120
|
+
# Dog.create! # creates dog using dog writing connection
|
121
|
+
# end
|
122
|
+
#
|
123
|
+
# ActiveRecord::Base.connected_to(role: :reading) do
|
124
|
+
# Dog.create! # throws exception because we're on a replica
|
125
|
+
# end
|
126
|
+
#
|
127
|
+
# When swapping to a shard, the role must be passed as well. If a non-existent
|
128
|
+
# shard is passed, an +ActiveRecord::ConnectionNotEstablished+ error will be
|
129
|
+
# raised.
|
130
|
+
#
|
131
|
+
# When a shard and role is passed, Active Record will first lookup the role,
|
132
|
+
# and then look up the connection by shard key.
|
133
|
+
#
|
134
|
+
# ActiveRecord::Base.connected_to(role: :reading, shard: :shard_one_replica) do
|
135
|
+
# Dog.first # finds first Dog record stored on the shard one replica
|
136
|
+
# end
|
137
|
+
#
|
138
|
+
# The database kwarg is deprecated and will be removed in Rails 7.0.0 without replacement.
|
139
|
+
def connected_to(database: nil, role: nil, shard: nil, prevent_writes: false, &blk)
|
140
|
+
if legacy_connection_handling
|
141
|
+
if self != Base
|
142
|
+
raise NotImplementedError, "`connected_to` can only be called on ActiveRecord::Base with legacy connection handling."
|
143
|
+
end
|
144
|
+
else
|
145
|
+
if self != Base && !abstract_class
|
146
|
+
raise NotImplementedError, "calling `connected_to` is only allowed on ActiveRecord::Base or abstract classes."
|
147
|
+
end
|
148
|
+
|
149
|
+
if name != connection_specification_name && !primary_class?
|
150
|
+
raise NotImplementedError, "calling `connected_to` is only allowed on the abstract class that established the connection."
|
151
|
+
end
|
152
|
+
end
|
51
153
|
|
52
|
-
|
53
|
-
|
54
|
-
|
154
|
+
if database && (role || shard)
|
155
|
+
raise ArgumentError, "`connected_to` cannot accept a `database` argument with any other arguments."
|
156
|
+
elsif database
|
157
|
+
ActiveSupport::Deprecation.warn("The database key in `connected_to` is deprecated. It will be removed in Rails 7.0.0 without replacement.")
|
55
158
|
|
56
|
-
|
57
|
-
|
58
|
-
|
159
|
+
if database.is_a?(Hash)
|
160
|
+
role, database = database.first
|
161
|
+
role = role.to_sym
|
162
|
+
end
|
59
163
|
|
60
|
-
|
164
|
+
db_config, owner_name = resolve_config_for_connection(database)
|
165
|
+
handler = lookup_connection_handler(role)
|
166
|
+
|
167
|
+
handler.establish_connection(db_config, owner_name: owner_name, role: role)
|
168
|
+
|
169
|
+
with_handler(role, &blk)
|
170
|
+
elsif role || shard
|
171
|
+
unless role
|
172
|
+
raise ArgumentError, "`connected_to` cannot accept a `shard` argument without a `role`."
|
173
|
+
end
|
174
|
+
|
175
|
+
with_role_and_shard(role, shard, prevent_writes, &blk)
|
176
|
+
else
|
177
|
+
raise ArgumentError, "must provide a `shard` and/or `role`."
|
178
|
+
end
|
61
179
|
end
|
62
180
|
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
181
|
+
# Connects a role and/or shard to the provided connection names. Optionally +prevent_writes+
|
182
|
+
# can be passed to block writes on a connection. +reading+ will automatically set
|
183
|
+
# +prevent_writes+ to true.
|
184
|
+
#
|
185
|
+
# +connected_to_many+ is an alternative to deeply nested +connected_to+ blocks.
|
186
|
+
#
|
187
|
+
# Usage:
|
188
|
+
#
|
189
|
+
# ActiveRecord::Base.connected_to_many(AnimalsRecord, MealsRecord, role: :reading) do
|
190
|
+
# Dog.first # Read from animals replica
|
191
|
+
# Dinner.first # Read from meals replica
|
192
|
+
# Person.first # Read from primary writer
|
193
|
+
# end
|
194
|
+
def connected_to_many(*classes, role:, shard: nil, prevent_writes: false)
|
195
|
+
classes = classes.flatten
|
196
|
+
|
197
|
+
if legacy_connection_handling
|
198
|
+
raise NotImplementedError, "connected_to_many is not available with legacy connection handling"
|
67
199
|
end
|
68
200
|
|
69
|
-
|
70
|
-
|
71
|
-
def resolve
|
72
|
-
ConnectionAdapters::ConnectionSpecification::Resolver.new(config).resolve_all
|
201
|
+
if self != Base || classes.include?(Base)
|
202
|
+
raise NotImplementedError, "connected_to_many can only be called on ActiveRecord::Base."
|
73
203
|
end
|
74
204
|
|
75
|
-
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
205
|
+
prevent_writes = true if role == reading_role
|
206
|
+
|
207
|
+
connected_to_stack << { role: role, shard: shard, prevent_writes: prevent_writes, klasses: classes }
|
208
|
+
yield
|
209
|
+
ensure
|
210
|
+
connected_to_stack.pop
|
211
|
+
end
|
212
|
+
|
213
|
+
# Use a specified connection.
|
214
|
+
#
|
215
|
+
# This method is useful for ensuring that a specific connection is
|
216
|
+
# being used. For example, when booting a console in readonly mode.
|
217
|
+
#
|
218
|
+
# It is not recommended to use this method in a request since it
|
219
|
+
# does not yield to a block like +connected_to+.
|
220
|
+
def connecting_to(role: default_role, shard: default_shard, prevent_writes: false)
|
221
|
+
if legacy_connection_handling
|
222
|
+
raise NotImplementedError, "`connecting_to` is not available with `legacy_connection_handling`."
|
223
|
+
end
|
224
|
+
|
225
|
+
prevent_writes = true if role == reading_role
|
226
|
+
|
227
|
+
self.connected_to_stack << { role: role, shard: shard, prevent_writes: prevent_writes, klasses: [self] }
|
228
|
+
end
|
229
|
+
|
230
|
+
# Prevent writing to the database regardless of role.
|
231
|
+
#
|
232
|
+
# In some cases you may want to prevent writes to the database
|
233
|
+
# even if you are on a database that can write. +while_preventing_writes+
|
234
|
+
# will prevent writes to the database for the duration of the block.
|
235
|
+
#
|
236
|
+
# This method does not provide the same protection as a readonly
|
237
|
+
# user and is meant to be a safeguard against accidental writes.
|
238
|
+
#
|
239
|
+
# See +READ_QUERY+ for the queries that are blocked by this
|
240
|
+
# method.
|
241
|
+
def while_preventing_writes(enabled = true, &block)
|
242
|
+
if legacy_connection_handling
|
243
|
+
connection_handler.while_preventing_writes(enabled, &block)
|
244
|
+
else
|
245
|
+
connected_to(role: current_role, prevent_writes: enabled, &block)
|
246
|
+
end
|
247
|
+
end
|
248
|
+
|
249
|
+
# Returns true if role is the current connected role.
|
250
|
+
#
|
251
|
+
# ActiveRecord::Base.connected_to(role: :writing) do
|
252
|
+
# ActiveRecord::Base.connected_to?(role: :writing) #=> true
|
253
|
+
# ActiveRecord::Base.connected_to?(role: :reading) #=> false
|
254
|
+
# end
|
255
|
+
def connected_to?(role:, shard: ActiveRecord::Base.default_shard)
|
256
|
+
current_role == role.to_sym && current_shard == shard.to_sym
|
257
|
+
end
|
258
|
+
|
259
|
+
def lookup_connection_handler(handler_key) # :nodoc:
|
260
|
+
if ActiveRecord::Base.legacy_connection_handling
|
261
|
+
handler_key ||= ActiveRecord::Base.writing_role
|
262
|
+
connection_handlers[handler_key] ||= ActiveRecord::ConnectionAdapters::ConnectionHandler.new
|
263
|
+
else
|
264
|
+
ActiveRecord::Base.connection_handler
|
265
|
+
end
|
266
|
+
end
|
267
|
+
|
268
|
+
# Clears the query cache for all connections associated with the current thread.
|
269
|
+
def clear_query_caches_for_current_thread
|
270
|
+
if ActiveRecord::Base.legacy_connection_handling
|
271
|
+
ActiveRecord::Base.connection_handlers.each_value do |handler|
|
272
|
+
clear_on_handler(handler)
|
83
273
|
end
|
274
|
+
else
|
275
|
+
clear_on_handler(ActiveRecord::Base.connection_handler)
|
276
|
+
end
|
84
277
|
end
|
85
278
|
|
86
279
|
# Returns the connection currently associated with the class. This can
|
@@ -92,14 +285,18 @@ module ActiveRecord
|
|
92
285
|
|
93
286
|
attr_writer :connection_specification_name
|
94
287
|
|
95
|
-
# Return the specification name from the current class or its parent.
|
288
|
+
# Return the connection specification name from the current class or its parent.
|
96
289
|
def connection_specification_name
|
97
290
|
if !defined?(@connection_specification_name) || @connection_specification_name.nil?
|
98
|
-
return self == Base ?
|
291
|
+
return self == Base ? Base.name : superclass.connection_specification_name
|
99
292
|
end
|
100
293
|
@connection_specification_name
|
101
294
|
end
|
102
295
|
|
296
|
+
def primary_class? # :nodoc:
|
297
|
+
self == Base || defined?(ApplicationRecord) && self == ApplicationRecord
|
298
|
+
end
|
299
|
+
|
103
300
|
# Returns the configuration of the associated connection as a hash:
|
104
301
|
#
|
105
302
|
# ActiveRecord::Base.connection_config
|
@@ -107,20 +304,32 @@ module ActiveRecord
|
|
107
304
|
#
|
108
305
|
# Please use only for reading.
|
109
306
|
def connection_config
|
110
|
-
connection_pool.
|
307
|
+
connection_pool.db_config.configuration_hash
|
308
|
+
end
|
309
|
+
deprecate connection_config: "Use connection_db_config instead"
|
310
|
+
|
311
|
+
# Returns the db_config object from the associated connection:
|
312
|
+
#
|
313
|
+
# ActiveRecord::Base.connection_db_config
|
314
|
+
# #<ActiveRecord::DatabaseConfigurations::HashConfig:0x00007fd1acbded10 @env_name="development",
|
315
|
+
# @name="primary", @config={pool: 5, timeout: 5000, database: "db/development.sqlite3", adapter: "sqlite3"}>
|
316
|
+
#
|
317
|
+
# Use only for reading.
|
318
|
+
def connection_db_config
|
319
|
+
connection_pool.db_config
|
111
320
|
end
|
112
321
|
|
113
322
|
def connection_pool
|
114
|
-
connection_handler.retrieve_connection_pool(connection_specification_name) || raise(ConnectionNotEstablished)
|
323
|
+
connection_handler.retrieve_connection_pool(connection_specification_name, role: current_role, shard: current_shard) || raise(ConnectionNotEstablished)
|
115
324
|
end
|
116
325
|
|
117
326
|
def retrieve_connection
|
118
|
-
connection_handler.retrieve_connection(connection_specification_name)
|
327
|
+
connection_handler.retrieve_connection(connection_specification_name, role: current_role, shard: current_shard)
|
119
328
|
end
|
120
329
|
|
121
330
|
# Returns +true+ if Active Record is connected.
|
122
331
|
def connected?
|
123
|
-
connection_handler.connected?(connection_specification_name)
|
332
|
+
connection_handler.connected?(connection_specification_name, role: current_role, shard: current_shard)
|
124
333
|
end
|
125
334
|
|
126
335
|
def remove_connection(name = nil)
|
@@ -128,11 +337,11 @@ module ActiveRecord
|
|
128
337
|
# if removing a connection that has a pool, we reset the
|
129
338
|
# connection_specification_name so it will use the parent
|
130
339
|
# pool.
|
131
|
-
if connection_handler.retrieve_connection_pool(name)
|
340
|
+
if connection_handler.retrieve_connection_pool(name, role: current_role, shard: current_shard)
|
132
341
|
self.connection_specification_name = nil
|
133
342
|
end
|
134
343
|
|
135
|
-
connection_handler.
|
344
|
+
connection_handler.remove_connection_pool(name, role: current_role, shard: current_shard)
|
136
345
|
end
|
137
346
|
|
138
347
|
def clear_cache! # :nodoc:
|
@@ -141,5 +350,56 @@ module ActiveRecord
|
|
141
350
|
|
142
351
|
delegate :clear_active_connections!, :clear_reloadable_connections!,
|
143
352
|
:clear_all_connections!, :flush_idle_connections!, to: :connection_handler
|
353
|
+
|
354
|
+
private
|
355
|
+
def clear_on_handler(handler)
|
356
|
+
handler.all_connection_pools.each do |pool|
|
357
|
+
pool.connection.clear_query_cache if pool.active_connection?
|
358
|
+
end
|
359
|
+
end
|
360
|
+
|
361
|
+
def resolve_config_for_connection(config_or_env)
|
362
|
+
raise "Anonymous class is not allowed." unless name
|
363
|
+
|
364
|
+
owner_name = primary_class? ? Base.name : name
|
365
|
+
self.connection_specification_name = owner_name
|
366
|
+
|
367
|
+
db_config = Base.configurations.resolve(config_or_env)
|
368
|
+
[db_config, self]
|
369
|
+
end
|
370
|
+
|
371
|
+
def with_handler(handler_key, &blk)
|
372
|
+
handler = lookup_connection_handler(handler_key)
|
373
|
+
swap_connection_handler(handler, &blk)
|
374
|
+
end
|
375
|
+
|
376
|
+
def with_role_and_shard(role, shard, prevent_writes)
|
377
|
+
prevent_writes = true if role == reading_role
|
378
|
+
|
379
|
+
if ActiveRecord::Base.legacy_connection_handling
|
380
|
+
with_handler(role.to_sym) do
|
381
|
+
connection_handler.while_preventing_writes(prevent_writes) do
|
382
|
+
self.connected_to_stack << { shard: shard, klasses: [self] }
|
383
|
+
yield
|
384
|
+
end
|
385
|
+
end
|
386
|
+
else
|
387
|
+
self.connected_to_stack << { role: role, shard: shard, prevent_writes: prevent_writes, klasses: [self] }
|
388
|
+
return_value = yield
|
389
|
+
return_value.load if return_value.is_a? ActiveRecord::Relation
|
390
|
+
return_value
|
391
|
+
end
|
392
|
+
ensure
|
393
|
+
self.connected_to_stack.pop
|
394
|
+
end
|
395
|
+
|
396
|
+
def swap_connection_handler(handler, &blk) # :nodoc:
|
397
|
+
old_handler, ActiveRecord::Base.connection_handler = ActiveRecord::Base.connection_handler, handler
|
398
|
+
return_value = yield
|
399
|
+
return_value.load if return_value.is_a? ActiveRecord::Relation
|
400
|
+
return_value
|
401
|
+
ensure
|
402
|
+
ActiveRecord::Base.connection_handler = old_handler
|
403
|
+
end
|
144
404
|
end
|
145
405
|
end
|