activerecord 7.0.8 → 7.1.0.beta1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (227) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1348 -1546
  3. data/MIT-LICENSE +1 -1
  4. data/README.rdoc +15 -16
  5. data/lib/active_record/aggregations.rb +16 -13
  6. data/lib/active_record/association_relation.rb +1 -1
  7. data/lib/active_record/associations/association.rb +18 -3
  8. data/lib/active_record/associations/association_scope.rb +16 -9
  9. data/lib/active_record/associations/belongs_to_association.rb +14 -6
  10. data/lib/active_record/associations/builder/association.rb +3 -3
  11. data/lib/active_record/associations/builder/belongs_to.rb +21 -8
  12. data/lib/active_record/associations/builder/has_and_belongs_to_many.rb +1 -5
  13. data/lib/active_record/associations/builder/singular_association.rb +4 -0
  14. data/lib/active_record/associations/collection_association.rb +17 -9
  15. data/lib/active_record/associations/collection_proxy.rb +16 -11
  16. data/lib/active_record/associations/foreign_association.rb +10 -3
  17. data/lib/active_record/associations/has_many_association.rb +20 -13
  18. data/lib/active_record/associations/has_many_through_association.rb +10 -6
  19. data/lib/active_record/associations/has_one_association.rb +10 -3
  20. data/lib/active_record/associations/join_dependency.rb +10 -8
  21. data/lib/active_record/associations/preloader/association.rb +27 -6
  22. data/lib/active_record/associations/preloader.rb +12 -9
  23. data/lib/active_record/associations/singular_association.rb +1 -1
  24. data/lib/active_record/associations/through_association.rb +22 -11
  25. data/lib/active_record/associations.rb +193 -97
  26. data/lib/active_record/attribute_assignment.rb +0 -2
  27. data/lib/active_record/attribute_methods/before_type_cast.rb +17 -0
  28. data/lib/active_record/attribute_methods/dirty.rb +40 -26
  29. data/lib/active_record/attribute_methods/primary_key.rb +76 -24
  30. data/lib/active_record/attribute_methods/query.rb +28 -16
  31. data/lib/active_record/attribute_methods/read.rb +18 -5
  32. data/lib/active_record/attribute_methods/serialization.rb +150 -31
  33. data/lib/active_record/attribute_methods/write.rb +3 -3
  34. data/lib/active_record/attribute_methods.rb +105 -21
  35. data/lib/active_record/attributes.rb +3 -3
  36. data/lib/active_record/autosave_association.rb +55 -9
  37. data/lib/active_record/base.rb +7 -2
  38. data/lib/active_record/callbacks.rb +10 -24
  39. data/lib/active_record/coders/column_serializer.rb +61 -0
  40. data/lib/active_record/coders/json.rb +1 -1
  41. data/lib/active_record/coders/yaml_column.rb +70 -42
  42. data/lib/active_record/connection_adapters/abstract/connection_handler.rb +163 -88
  43. data/lib/active_record/connection_adapters/abstract/connection_pool/queue.rb +2 -0
  44. data/lib/active_record/connection_adapters/abstract/connection_pool/reaper.rb +3 -1
  45. data/lib/active_record/connection_adapters/abstract/connection_pool.rb +63 -43
  46. data/lib/active_record/connection_adapters/abstract/database_limits.rb +5 -0
  47. data/lib/active_record/connection_adapters/abstract/database_statements.rb +109 -32
  48. data/lib/active_record/connection_adapters/abstract/query_cache.rb +60 -22
  49. data/lib/active_record/connection_adapters/abstract/quoting.rb +41 -6
  50. data/lib/active_record/connection_adapters/abstract/savepoints.rb +4 -3
  51. data/lib/active_record/connection_adapters/abstract/schema_creation.rb +18 -4
  52. data/lib/active_record/connection_adapters/abstract/schema_definitions.rb +137 -11
  53. data/lib/active_record/connection_adapters/abstract/schema_statements.rb +289 -122
  54. data/lib/active_record/connection_adapters/abstract/transaction.rb +280 -58
  55. data/lib/active_record/connection_adapters/abstract_adapter.rb +502 -91
  56. data/lib/active_record/connection_adapters/abstract_mysql_adapter.rb +200 -108
  57. data/lib/active_record/connection_adapters/column.rb +9 -0
  58. data/lib/active_record/connection_adapters/mysql/column.rb +1 -0
  59. data/lib/active_record/connection_adapters/mysql/database_statements.rb +22 -143
  60. data/lib/active_record/connection_adapters/mysql/quoting.rb +16 -12
  61. data/lib/active_record/connection_adapters/mysql/schema_creation.rb +9 -0
  62. data/lib/active_record/connection_adapters/mysql/schema_definitions.rb +6 -0
  63. data/lib/active_record/connection_adapters/mysql/schema_dumper.rb +1 -1
  64. data/lib/active_record/connection_adapters/mysql/schema_statements.rb +17 -12
  65. data/lib/active_record/connection_adapters/mysql2/database_statements.rb +148 -0
  66. data/lib/active_record/connection_adapters/mysql2_adapter.rb +98 -53
  67. data/lib/active_record/connection_adapters/pool_config.rb +14 -5
  68. data/lib/active_record/connection_adapters/pool_manager.rb +19 -9
  69. data/lib/active_record/connection_adapters/postgresql/column.rb +1 -2
  70. data/lib/active_record/connection_adapters/postgresql/database_statements.rb +76 -29
  71. data/lib/active_record/connection_adapters/postgresql/oid/range.rb +11 -2
  72. data/lib/active_record/connection_adapters/postgresql/quoting.rb +9 -6
  73. data/lib/active_record/connection_adapters/postgresql/referential_integrity.rb +3 -9
  74. data/lib/active_record/connection_adapters/postgresql/schema_creation.rb +76 -6
  75. data/lib/active_record/connection_adapters/postgresql/schema_definitions.rb +131 -2
  76. data/lib/active_record/connection_adapters/postgresql/schema_dumper.rb +42 -0
  77. data/lib/active_record/connection_adapters/postgresql/schema_statements.rb +351 -54
  78. data/lib/active_record/connection_adapters/postgresql_adapter.rb +336 -168
  79. data/lib/active_record/connection_adapters/schema_cache.rb +287 -59
  80. data/lib/active_record/connection_adapters/sqlite3/column.rb +49 -0
  81. data/lib/active_record/connection_adapters/sqlite3/database_statements.rb +42 -36
  82. data/lib/active_record/connection_adapters/sqlite3/quoting.rb +4 -3
  83. data/lib/active_record/connection_adapters/sqlite3/schema_definitions.rb +1 -0
  84. data/lib/active_record/connection_adapters/sqlite3/schema_statements.rb +26 -7
  85. data/lib/active_record/connection_adapters/sqlite3_adapter.rb +162 -77
  86. data/lib/active_record/connection_adapters/statement_pool.rb +7 -0
  87. data/lib/active_record/connection_adapters/trilogy/database_statements.rb +98 -0
  88. data/lib/active_record/connection_adapters/trilogy_adapter.rb +254 -0
  89. data/lib/active_record/connection_adapters.rb +3 -1
  90. data/lib/active_record/connection_handling.rb +71 -94
  91. data/lib/active_record/core.rb +128 -138
  92. data/lib/active_record/counter_cache.rb +46 -25
  93. data/lib/active_record/database_configurations/database_config.rb +9 -3
  94. data/lib/active_record/database_configurations/hash_config.rb +22 -12
  95. data/lib/active_record/database_configurations/url_config.rb +17 -11
  96. data/lib/active_record/database_configurations.rb +86 -33
  97. data/lib/active_record/delegated_type.rb +8 -3
  98. data/lib/active_record/deprecator.rb +7 -0
  99. data/lib/active_record/destroy_association_async_job.rb +2 -0
  100. data/lib/active_record/encryption/auto_filtered_parameters.rb +66 -0
  101. data/lib/active_record/encryption/cipher/aes256_gcm.rb +4 -1
  102. data/lib/active_record/encryption/config.rb +25 -1
  103. data/lib/active_record/encryption/configurable.rb +12 -19
  104. data/lib/active_record/encryption/context.rb +10 -3
  105. data/lib/active_record/encryption/contexts.rb +5 -1
  106. data/lib/active_record/encryption/derived_secret_key_provider.rb +8 -2
  107. data/lib/active_record/encryption/encryptable_record.rb +36 -18
  108. data/lib/active_record/encryption/encrypted_attribute_type.rb +17 -6
  109. data/lib/active_record/encryption/extended_deterministic_queries.rb +66 -54
  110. data/lib/active_record/encryption/extended_deterministic_uniqueness_validator.rb +2 -2
  111. data/lib/active_record/encryption/key_generator.rb +12 -1
  112. data/lib/active_record/encryption/message_serializer.rb +2 -0
  113. data/lib/active_record/encryption/properties.rb +3 -3
  114. data/lib/active_record/encryption/scheme.rb +19 -22
  115. data/lib/active_record/encryption.rb +1 -0
  116. data/lib/active_record/enum.rb +113 -26
  117. data/lib/active_record/errors.rb +89 -15
  118. data/lib/active_record/explain.rb +23 -3
  119. data/lib/active_record/fixture_set/model_metadata.rb +14 -4
  120. data/lib/active_record/fixture_set/render_context.rb +2 -0
  121. data/lib/active_record/fixture_set/table_row.rb +29 -8
  122. data/lib/active_record/fixtures.rb +119 -71
  123. data/lib/active_record/future_result.rb +30 -5
  124. data/lib/active_record/gem_version.rb +4 -4
  125. data/lib/active_record/inheritance.rb +30 -16
  126. data/lib/active_record/insert_all.rb +55 -8
  127. data/lib/active_record/integration.rb +8 -8
  128. data/lib/active_record/internal_metadata.rb +118 -30
  129. data/lib/active_record/locking/pessimistic.rb +5 -2
  130. data/lib/active_record/log_subscriber.rb +29 -12
  131. data/lib/active_record/marshalling.rb +56 -0
  132. data/lib/active_record/message_pack.rb +124 -0
  133. data/lib/active_record/middleware/database_selector/resolver.rb +4 -0
  134. data/lib/active_record/middleware/database_selector.rb +5 -7
  135. data/lib/active_record/middleware/shard_selector.rb +3 -1
  136. data/lib/active_record/migration/command_recorder.rb +100 -4
  137. data/lib/active_record/migration/compatibility.rb +131 -5
  138. data/lib/active_record/migration/default_strategy.rb +23 -0
  139. data/lib/active_record/migration/execution_strategy.rb +19 -0
  140. data/lib/active_record/migration.rb +213 -109
  141. data/lib/active_record/model_schema.rb +47 -27
  142. data/lib/active_record/nested_attributes.rb +28 -3
  143. data/lib/active_record/normalization.rb +158 -0
  144. data/lib/active_record/persistence.rb +183 -33
  145. data/lib/active_record/promise.rb +84 -0
  146. data/lib/active_record/query_cache.rb +3 -21
  147. data/lib/active_record/query_logs.rb +77 -52
  148. data/lib/active_record/query_logs_formatter.rb +41 -0
  149. data/lib/active_record/querying.rb +15 -2
  150. data/lib/active_record/railtie.rb +107 -45
  151. data/lib/active_record/railties/controller_runtime.rb +10 -5
  152. data/lib/active_record/railties/databases.rake +139 -145
  153. data/lib/active_record/railties/job_runtime.rb +23 -0
  154. data/lib/active_record/readonly_attributes.rb +32 -5
  155. data/lib/active_record/reflection.rb +169 -45
  156. data/lib/active_record/relation/batches/batch_enumerator.rb +5 -3
  157. data/lib/active_record/relation/batches.rb +190 -61
  158. data/lib/active_record/relation/calculations.rb +152 -63
  159. data/lib/active_record/relation/delegation.rb +22 -8
  160. data/lib/active_record/relation/finder_methods.rb +85 -15
  161. data/lib/active_record/relation/merger.rb +2 -0
  162. data/lib/active_record/relation/predicate_builder/association_query_value.rb +11 -2
  163. data/lib/active_record/relation/predicate_builder/relation_handler.rb +5 -1
  164. data/lib/active_record/relation/predicate_builder.rb +26 -14
  165. data/lib/active_record/relation/query_attribute.rb +2 -1
  166. data/lib/active_record/relation/query_methods.rb +351 -62
  167. data/lib/active_record/relation/spawn_methods.rb +18 -1
  168. data/lib/active_record/relation.rb +76 -35
  169. data/lib/active_record/result.rb +19 -5
  170. data/lib/active_record/runtime_registry.rb +10 -1
  171. data/lib/active_record/sanitization.rb +51 -11
  172. data/lib/active_record/schema.rb +2 -3
  173. data/lib/active_record/schema_dumper.rb +41 -7
  174. data/lib/active_record/schema_migration.rb +68 -33
  175. data/lib/active_record/scoping/default.rb +15 -5
  176. data/lib/active_record/scoping/named.rb +2 -2
  177. data/lib/active_record/scoping.rb +2 -1
  178. data/lib/active_record/secure_password.rb +60 -0
  179. data/lib/active_record/secure_token.rb +21 -3
  180. data/lib/active_record/signed_id.rb +7 -5
  181. data/lib/active_record/store.rb +8 -8
  182. data/lib/active_record/suppressor.rb +3 -1
  183. data/lib/active_record/table_metadata.rb +10 -1
  184. data/lib/active_record/tasks/database_tasks.rb +127 -105
  185. data/lib/active_record/tasks/mysql_database_tasks.rb +15 -6
  186. data/lib/active_record/tasks/postgresql_database_tasks.rb +16 -13
  187. data/lib/active_record/tasks/sqlite_database_tasks.rb +14 -7
  188. data/lib/active_record/test_fixtures.rb +113 -96
  189. data/lib/active_record/timestamp.rb +26 -14
  190. data/lib/active_record/token_for.rb +113 -0
  191. data/lib/active_record/touch_later.rb +11 -6
  192. data/lib/active_record/transactions.rb +36 -10
  193. data/lib/active_record/type/adapter_specific_registry.rb +1 -8
  194. data/lib/active_record/type/internal/timezone.rb +7 -2
  195. data/lib/active_record/type/time.rb +4 -0
  196. data/lib/active_record/validations/absence.rb +1 -1
  197. data/lib/active_record/validations/numericality.rb +5 -4
  198. data/lib/active_record/validations/presence.rb +5 -28
  199. data/lib/active_record/validations/uniqueness.rb +47 -2
  200. data/lib/active_record/validations.rb +8 -4
  201. data/lib/active_record/version.rb +1 -1
  202. data/lib/active_record.rb +121 -16
  203. data/lib/arel/errors.rb +10 -0
  204. data/lib/arel/factory_methods.rb +4 -0
  205. data/lib/arel/nodes/binary.rb +6 -1
  206. data/lib/arel/nodes/bound_sql_literal.rb +61 -0
  207. data/lib/arel/nodes/cte.rb +36 -0
  208. data/lib/arel/nodes/fragments.rb +35 -0
  209. data/lib/arel/nodes/homogeneous_in.rb +0 -8
  210. data/lib/arel/nodes/leading_join.rb +8 -0
  211. data/lib/arel/nodes/node.rb +111 -2
  212. data/lib/arel/nodes/sql_literal.rb +6 -0
  213. data/lib/arel/nodes/table_alias.rb +4 -0
  214. data/lib/arel/nodes.rb +4 -0
  215. data/lib/arel/predications.rb +2 -0
  216. data/lib/arel/table.rb +9 -5
  217. data/lib/arel/visitors/mysql.rb +8 -1
  218. data/lib/arel/visitors/to_sql.rb +81 -17
  219. data/lib/arel/visitors/visitor.rb +2 -2
  220. data/lib/arel.rb +16 -2
  221. data/lib/rails/generators/active_record/application_record/USAGE +8 -0
  222. data/lib/rails/generators/active_record/migration.rb +3 -1
  223. data/lib/rails/generators/active_record/model/USAGE +113 -0
  224. data/lib/rails/generators/active_record/model/model_generator.rb +15 -6
  225. metadata +48 -13
  226. data/lib/active_record/connection_adapters/legacy_pool_manager.rb +0 -35
  227. data/lib/active_record/null_relation.rb +0 -63
data/CHANGELOG.md CHANGED
@@ -1,2376 +1,2178 @@
1
- ## Rails 7.0.8 (September 09, 2023) ##
1
+ ## Rails 7.1.0.beta1 (September 13, 2023) ##
2
2
 
3
- * Fix `change_column` not setting `precision: 6` on `datetime` columns when
4
- using 7.0+ Migrations and SQLite.
3
+ * Encryption now supports `support_unencrypted_data` being set per-attribute.
5
4
 
6
- *Hartley McGuire*
5
+ You can now opt out of `support_unencrypted_data` on a specific encrypted attribute.
6
+ This only has an effect if `ActiveRecord::Encryption.config.support_unencrypted_data == true`.
7
7
 
8
- * Fix unscope is not working in specific case
9
-
10
- Before:
11
8
  ```ruby
12
- Post.where(id: 1...3).unscope(where: :id).to_sql # "SELECT `posts`.* FROM `posts` WHERE `posts`.`id` >= 1 AND `posts`.`id` < 3"
13
-
14
- ```
15
-
16
- After:
17
- ```ruby
18
- Post.where(id: 1...3).unscope(where: :id).to_sql # "SELECT `posts`.* FROM `posts`"
9
+ class User < ActiveRecord::Base
10
+ encrypts :name, deterministic: true, support_unencrypted_data: false
11
+ encrypts :email, deterministic: true
12
+ end
19
13
  ```
20
14
 
21
- Fixes #48094.
15
+ *Alex Ghiculescu*
22
16
 
23
- *Kazuya Hatanaka*
17
+ * Add instrumentation for Active Record transactions
24
18
 
25
- * Fix associations to a STI model including a `class_name` parameter
19
+ Allows subscribing to transaction events for tracking/instrumentation. The event payload contains the connection, as well as timing details.
26
20
 
27
21
  ```ruby
28
- class Product < ApplicationRecord
29
- has_many :requests, as: :requestable, class_name: "ProductRequest", dependent: :destroy
30
- end
31
-
32
- # STI tables
33
- class Request < ApplicationRecord
34
- belongs_to :requestable, polymorphic: true
35
-
36
- validate :request_type, presence: true
37
- end
38
-
39
- class ProductRequest < Request
40
- belongs_to :user
22
+ ActiveSupport::Notifications.subscribe("transaction.active_record") do |event|
23
+ puts "Transaction event occurred!"
24
+ connection = event.payload[:connection]
25
+ puts "Connection: #{connection.inspect}"
41
26
  end
42
27
  ```
43
28
 
44
- Accessing such association would lead to:
45
-
46
- ```
47
- table_metadata.rb:22:in `has_column?': undefined method `key?' for nil:NilClass (NoMethodError)
48
- ```
29
+ *Daniel Colson*, *Ian Candy*
49
30
 
50
- *Romain Filinto*
31
+ * Support composite foreign keys via migration helpers.
51
32
 
52
- * Fix `change_table` setting datetime precision for 6.1 Migrations
53
-
54
- *Hartley McGuire*
55
-
56
- * Fix change_column setting datetime precision for 6.1 Migrations
57
-
58
- *Hartley McGuire*
59
-
60
- ## Rails 7.0.7.2 (August 22, 2023) ##
61
-
62
- * No changes.
63
-
64
-
65
- ## Rails 7.0.7.1 (August 22, 2023) ##
66
-
67
- * No changes.
68
-
69
-
70
- ## Rails 7.0.7 (August 09, 2023) ##
71
-
72
- * Restores functionality to the missing method when using enums and fixes.
73
-
74
- *paulreece*
75
-
76
- * Fix `StatementCache::Substitute` with serialized type.
77
-
78
- *ywenc*
79
-
80
- * Fix `:db_runtime` on notification payload when application have multiple databases.
81
-
82
- *Eileen M. Uchitelle*
83
-
84
- * Correctly dump check constraints for MySQL 8.0.16+.
85
-
86
- *Steve Hill*
33
+ ```ruby
34
+ # Assuming "carts" table has "(shop_id, user_id)" as a primary key.
87
35
 
88
- * Fix `ActiveRecord::QueryMethods#in_order_of` to include `nil`s, to match the
89
- behavior of `Enumerable#in_order_of`.
36
+ add_foreign_key(:orders, :carts, primary_key: [:shop_id, :user_id])
90
37
 
91
- For example, `Post.in_order_of(:title, [nil, "foo"])` will now include posts
92
- with `nil` titles, the same as `Post.all.to_a.in_order_of(:title, [nil, "foo"])`.
38
+ remove_foreign_key(:orders, :carts, primary_key: [:shop_id, :user_id])
39
+ foreign_key_exists?(:orders, :carts, primary_key: [:shop_id, :user_id])
40
+ ```
93
41
 
94
42
  *fatkodima*
95
43
 
96
- * Revert "Fix autosave associations with validations added on `:base` of the associated objects."
97
-
98
- This change intended to remove the :base attribute from the message,
99
- but broke many assumptions which key these errors were stored.
100
-
101
- *zzak*
102
-
103
- * Fix `#previously_new_record?` to return true for destroyed records.
104
-
105
- Before, if a record was created and then destroyed, `#previously_new_record?` would return true.
106
- Now, any UPDATE or DELETE to a record is considered a change, and will result in `#previously_new_record?`
107
- returning false.
108
-
109
- *Adrianna Chang*
110
-
111
- * Revert breaking changes to `has_one` relationship deleting the old record before the new one is validated.
112
-
113
- *zzak*
114
-
115
- * Fix support for Active Record instances being uses in queries.
116
-
117
- As of `7.0.5`, query arguments were deep duped to avoid mutations impacting
118
- the query cache, but this had the adverse effect to clearing the primary key when
119
- the query argument contained an `ActiveRecord::Base` instance.
120
-
121
- This broke the `noticed` gem.
122
-
123
- *Jean Boussier*
124
-
125
-
126
- ## Rails 7.0.6 (June 29, 2023) ##
127
-
128
- * Fix autosave associations with validations added on `:base` of the associated objects.
44
+ * Adds support for `if_not_exists` when adding a check constraint.
129
45
 
130
- *fatkodima*
46
+ ```ruby
47
+ add_check_constraint :posts, "post_type IN ('blog', 'comment', 'share')", if_not_exists: true
48
+ ```
131
49
 
132
- * Fix result with anonymous PostgreSQL columns of different type from json.
50
+ *Cody Cutrer*
133
51
 
134
- *Oleksandr Avoiants*
52
+ * Raise an `ArgumentError` when `#accepts_nested_attributes_for` is declared more than once for an association in
53
+ the same class. Previously, the last declaration would silently override the previous one. Overriding in a subclass
54
+ is still allowed.
135
55
 
136
- * Preserve timestamp when setting an `ActiveSupport::TimeWithZone` value to `timestamptz` attribute.
56
+ *Joshua Young*
137
57
 
138
- *fatkodima*
58
+ * Deprecate `rewhere` argument on `#merge`.
139
59
 
140
- * Fix assignment into an `has_one` relationship deleting the old record before the new one is validated.
60
+ The `rewhere` argument on `#merge`is deprecated without replacement and
61
+ will be removed in Rails 7.2.
141
62
 
142
- *Jean Boussier*
63
+ *Adam Hess*
143
64
 
144
- * Fix where on association with has_one/has_many polymorphic relations.
65
+ * Fix unscope is not working in specific case
145
66
 
146
67
  Before:
147
68
  ```ruby
148
- Treasure.where(price_estimates: PriceEstimate.all)
149
- #=> SELECT (...) WHERE "treasures"."id" IN (SELECT "price_estimates"."estimate_of_id" FROM "price_estimates")
69
+ Post.where(id: 1...3).unscope(where: :id).to_sql # "SELECT `posts`.* FROM `posts` WHERE `posts`.`id` >= 1 AND `posts`.`id` < 3"
70
+
150
71
  ```
151
72
 
152
- Later:
73
+ After:
153
74
  ```ruby
154
- Treasure.where(price_estimates: PriceEstimate.all)
155
- #=> SELECT (...) WHERE "treasures"."id" IN (SELECT "price_estimates"."estimate_of_id" FROM "price_estimates" WHERE "price_estimates"."estimate_of_type" = 'Treasure')
75
+ Post.where(id: 1...3).unscope(where: :id).to_sql # "SELECT `posts`.* FROM `posts`"
156
76
  ```
157
77
 
158
- *Lázaro Nixon*
159
-
160
- * Fix decrementing counter caches on optimistically locked record deletion
161
-
162
- *fatkodima*
163
-
164
- * Ensure binary-destined values have binary encoding during type cast.
165
-
166
- *Matthew Draper*
167
-
168
- * Preserve existing column default functions when altering table in SQLite.
169
-
170
- *fatkodima*
171
-
172
- * Remove table alias added when using `where.missing` or `where.associated`.
173
-
174
- *fatkodima*
175
-
176
- * Fix `Enumerable#in_order_of` to only flatten first level to preserve nesting.
177
-
178
- *Miha Rekar*
179
-
180
-
181
- ## Rails 7.0.5.1 (June 26, 2023) ##
182
-
183
- * No changes.
184
-
185
- ## Rails 7.0.5 (May 24, 2023) ##
78
+ Fixes #48094.
186
79
 
187
- * Type cast `#attribute_changed?` `:from` and `:to` options.
80
+ *Kazuya Hatanaka*
188
81
 
189
- *Andrew Novoselac*
82
+ * Change `has_secure_token` default to `on: :initialize`
190
83
 
191
- * Fix `index_exists?` when column is an array.
84
+ Change the new default value from `on: :create` to `on: :initialize`
192
85
 
193
- *Eileen M. Uchitelle*
86
+ Can be controlled by the `config.active_record.generate_secure_token_on`
87
+ configuration:
194
88
 
195
- * Handle `Date` objects for PostgreSQL `timestamptz` columns.
89
+ ```ruby
90
+ config.active_record.generate_secure_token_on = :create
91
+ ```
196
92
 
197
- *Alex Ghiculescu*
93
+ *Sean Doyle*
198
94
 
199
- * Fix collation for changing column to non-string.
95
+ * Fix `change_column` not setting `precision: 6` on `datetime` columns when
96
+ using 7.0+ Migrations and SQLite.
200
97
 
201
98
  *Hartley McGuire*
202
99
 
203
- * Map through subtype in `PostgreSQL::OID::Array`.
204
-
205
- *Jonathan Hefner*
206
-
207
- * Store correct environment in `internal_metadata` when run rails `db:prepare`.
208
-
209
- *fatkodima*
210
-
211
- * Make sure `ActiveRecord::Relation#sum` works with objects that implement `#coerce` without deprecation.
212
-
213
- *Alex Ghiculescu*
214
-
215
- * Fix retrieving foreign keys referencing tables named like keywords in PostgreSQL and MySQL.
216
-
217
- *fatkodima*
218
-
219
- * Support UUIDs in Disable Joins.
220
-
221
- *Samuel Cochran*
222
-
223
- * Fix Active Record's explain for queries starting with comments.
224
-
225
- *fatkodima*
226
-
227
- * Fix incorrectly preloading through association records when middle association has been loaded.
228
-
229
- *Joshua Young*
230
-
231
- * Fix where.missing and where.associated for parent/child associations.
232
-
233
- *fatkodima*
234
-
235
- * Fix Enumerable#in_order_of to preserve duplicates.
236
-
237
- *fatkodima*
238
-
239
- * Fix autoincrement on primary key for mysql.
240
-
241
- *Eileen M. Uchitelle*
100
+ * Support composite identifiers in `to_key`
242
101
 
243
- * Restore ability to redefine column in `create_table` for Rails 5.2 migrations.
102
+ `to_key` avoids wrapping `#id` value into an `Array` if `#id` already an array
244
103
 
245
- *fatkodima*
246
-
247
- * Fix schema cache dumping of virtual columns.
248
-
249
- *fatkodima*
250
-
251
- * Fix Active Record grouped calculations on joined tables on column present in both tables.
252
-
253
- *fatkodima*
104
+ *Nikita Vasilevsky*
254
105
 
255
- * Fix mutation detection for serialized attributes backed by binary columns.
106
+ * Add validation option for `enum`
256
107
 
257
- *Jean Boussier*
108
+ ```ruby
109
+ class Contract < ApplicationRecord
110
+ enum :status, %w[in_progress completed], validate: true
111
+ end
112
+ Contract.new(status: "unknown").valid? # => false
113
+ Contract.new(status: nil).valid? # => false
114
+ Contract.new(status: "completed").valid? # => true
258
115
 
259
- * Fix a bug where using groups and counts with long table names would return incorrect results.
116
+ class Contract < ApplicationRecord
117
+ enum :status, %w[in_progress completed], validate: { allow_nil: true }
118
+ end
119
+ Contract.new(status: "unknown").valid? # => false
120
+ Contract.new(status: nil).valid? # => true
121
+ Contract.new(status: "completed").valid? # => true
122
+ ```
260
123
 
261
- *Shota Toguchi*, *Yusaku Ono*
124
+ *Edem Topuzov*, *Ryuta Kamizono*
262
125
 
263
- * Fix erroneous nil default precision on virtual datetime columns.
126
+ * Allow batching methods to use already loaded relation if available
264
127
 
265
- Prior to this change, virtual datetime columns did not have the same
266
- default precision as regular datetime columns, resulting in the following
267
- being erroneously equivalent:
128
+ Calling batch methods on already loaded relations will use the records previously loaded instead of retrieving
129
+ them from the database again.
268
130
 
269
- t.virtual :name, type: datetime, as: "expression"
270
- t.virtual :name, type: datetime, precision: nil, as: "expression"
131
+ *Adam Hess*
271
132
 
272
- This change fixes the default precision lookup, so virtual and regular
273
- datetime column default precisions match.
133
+ * Deprecate `read_attribute(:id)` returning the primary key if the primary key is not `:id`.
274
134
 
275
- *Sam Bostock*
135
+ Starting in Rails 7.2, `read_attribute(:id)` will return the value of the id column, regardless of the model's
136
+ primary key. To retrieve the value of the primary key, use `#id` instead. `read_attribute(:id)` for composite
137
+ primary key models will now return the value of the id column.
276
138
 
277
- * Fix a case where the query cache can return wrong values. See #46044
139
+ *Adrianna Chang*
278
140
 
279
- *Aaron Patterson*
141
+ * Fix `change_table` setting datetime precision for 6.1 Migrations
280
142
 
143
+ *Hartley McGuire*
281
144
 
282
- ## Rails 7.0.4.3 (March 13, 2023) ##
145
+ * Fix change_column setting datetime precision for 6.1 Migrations
283
146
 
284
- * No changes.
147
+ *Hartley McGuire*
285
148
 
149
+ * Add `ActiveRecord::Base#id_value` alias to access the raw value of a record's id column.
286
150
 
287
- ## Rails 7.0.4.2 (January 24, 2023) ##
151
+ This alias is only provided for models that declare an `:id` column.
288
152
 
289
- * No changes.
153
+ *Adrianna Chang*
290
154
 
155
+ * Fix previous change tracking for `ActiveRecord::Store` when using a column with JSON structured database type
291
156
 
292
- ## Rails 7.0.4.1 (January 17, 2023) ##
157
+ Before, the methods to access the changes made during the last save `#saved_change_to_key?`, `#saved_change_to_key`, and `#key_before_last_save` did not work if the store was defined as a `store_accessor` on a column with a JSON structured database type
293
158
 
294
- * Make sanitize_as_sql_comment more strict
159
+ *Robert DiMartino*
295
160
 
296
- Though this method was likely never meant to take user input, it was
297
- attempting sanitization. That sanitization could be bypassed with
298
- carefully crafted input.
161
+ * Fully support `NULLS [NOT] DISTINCT` for PostgreSQL 15+ indexes.
299
162
 
300
- This commit makes the sanitization more robust by replacing any
301
- occurrences of "/*" or "*/" with "/ *" or "* /". It also performs a
302
- first pass to remove one surrounding comment to avoid compatibility
303
- issues for users relying on the existing removal.
163
+ Previous work was done to allow the index to be created in a migration, but it was not
164
+ supported in schema.rb. Additionally, the matching for `NULLS [NOT] DISTINCT` was not
165
+ in the correct order, which could have resulted in inconsistent schema detection.
304
166
 
305
- This also clarifies in the documentation of annotate that it should not
306
- be provided user input.
167
+ *Gregory Jones*
307
168
 
308
- [CVE-2023-22794]
169
+ * Allow escaping of literal colon characters in `sanitize_sql_*` methods when named bind variables are used
309
170
 
310
- * Added integer width check to PostgreSQL::Quoting
171
+ *Justin Bull*
311
172
 
312
- Given a value outside the range for a 64bit signed integer type
313
- PostgreSQL will treat the column type as numeric. Comparing
314
- integer values against numeric values can result in a slow
315
- sequential scan.
173
+ * Fix `#previously_new_record?` to return true for destroyed records.
316
174
 
317
- This behavior is configurable via
318
- ActiveRecord::Base.raise_int_wider_than_64bit which defaults to true.
175
+ Before, if a record was created and then destroyed, `#previously_new_record?` would return true.
176
+ Now, any UPDATE or DELETE to a record is considered a change, and will result in `#previously_new_record?`
177
+ returning false.
319
178
 
320
- [CVE-2022-44566]
179
+ *Adrianna Chang*
321
180
 
181
+ * Specify callback in `has_secure_token`
322
182
 
323
- ## Rails 7.0.4 (September 09, 2022) ##
183
+ ```ruby
184
+ class User < ApplicationRecord
185
+ has_secure_token on: :initialize
186
+ end
324
187
 
325
- * Symbol is allowed by default for YAML columns
188
+ User.new.token # => "abc123...."
189
+ ```
326
190
 
327
- *Étienne Barrié*
191
+ *Sean Doyle*
328
192
 
329
- * Fix `ActiveRecord::Store` to serialize as a regular Hash
193
+ * Fix incrementation of in memory counter caches when associations overlap
330
194
 
331
- Previously it would serialize as an `ActiveSupport::HashWithIndifferentAccess`
332
- which is wasteful and cause problem with YAML safe_load.
195
+ When two associations had a similarly named counter cache column, Active Record
196
+ could sometime increment the wrong one.
333
197
 
334
- *Jean Boussier*
198
+ *Jacopo Beschi*, *Jean Boussier*
335
199
 
336
- * Add `timestamptz` as a time zone aware type for PostgreSQL
200
+ * Don't show secrets for Active Record's `Cipher::Aes256Gcm#inspect`.
337
201
 
338
- This is required for correctly parsing `timestamp with time zone` values in your database.
339
-
340
- If you don't want this, you can opt out by adding this initializer:
202
+ Before:
341
203
 
342
204
  ```ruby
343
- ActiveRecord::Base.time_zone_aware_types -= [:timestamptz]
205
+ ActiveRecord::Encryption::Cipher::Aes256Gcm.new(secret).inspect
206
+ "#<ActiveRecord::Encryption::Cipher::Aes256Gcm:0x0000000104888038 ... @secret=\"\\xAF\\bFh]LV}q\\nl\\xB2U\\xB3 ... >"
344
207
  ```
345
208
 
346
- *Alex Ghiculescu*
347
-
348
- * Fix supporting timezone awareness for `tsrange` and `tstzrange` array columns.
209
+ After:
349
210
 
350
211
  ```ruby
351
- # In database migrations
352
- add_column :shops, :open_hours, :tsrange, array: true
353
- # In app config
354
- ActiveRecord::Base.time_zone_aware_types += [:tsrange]
355
- # In the code times are properly converted to app time zone
356
- Shop.create!(open_hours: [Time.current..8.hour.from_now])
212
+ ActiveRecord::Encryption::Cipher::Aes256Gcm(secret).inspect
213
+ "#<ActiveRecord::Encryption::Cipher::Aes256Gcm:0x0000000104888038>"
357
214
  ```
358
215
 
359
- *Wojciech Wnętrzak*
360
-
361
- * Resolve issue where a relation cache_version could be left stale.
362
-
363
- Previously, when `reset` was called on a relation object it did not reset the cache_versions
364
- ivar. This led to a confusing situation where despite having the correct data the relation
365
- still reported a stale cache_version.
216
+ *Petrik de Heus*
366
217
 
367
- Usage:
218
+ * Bring back the historical behavior of committing transaction on non-local return.
368
219
 
369
220
  ```ruby
370
- developers = Developer.all
371
- developers.cache_version
372
-
373
- Developer.update_all(updated_at: Time.now.utc + 1.second)
374
-
375
- developers.cache_version # Stale cache_version
376
- developers.reset
377
- developers.cache_version # Returns the current correct cache_version
221
+ Model.transaction do
222
+ model.save
223
+ return
224
+ other_model.save # not executed
225
+ end
378
226
  ```
379
227
 
380
- Fixes #45341.
228
+ Historically only raised errors would trigger a rollback, but in Ruby `2.3`, the `timeout` library
229
+ started using `throw` to interrupt execution which had the adverse effect of committing open transactions.
381
230
 
382
- *Austen Madden*
231
+ To solve this, in Active Record 6.1 the behavior was changed to instead rollback the transaction as it was safer
232
+ than to potentially commit an incomplete transaction.
383
233
 
384
- * Fix `load_async` when called on an association proxy.
234
+ Using `return`, `break` or `throw` inside a `transaction` block was essentially deprecated from Rails 6.1 onwards.
385
235
 
386
- Calling `load_async` directly an association would schedule
387
- a query but never use it.
236
+ However with the release of `timeout 0.4.0`, `Timeout.timeout` now raises an error again, and Active Record is able
237
+ to return to its original, less surprising, behavior.
388
238
 
389
- ```ruby
390
- comments = post.comments.load_async # schedule a query
391
- comments.to_a # perform an entirely new sync query
239
+ This historical behavior can now be opt-ed in via:
240
+
241
+ ```
242
+ Rails.application.config.active_record.commit_transaction_on_non_local_return = true
392
243
  ```
393
244
 
394
- Now it does use the async query, however note that it doesn't
395
- cause the association to be loaded.
245
+ And is the default for new applications created in Rails 7.1.
396
246
 
397
247
  *Jean Boussier*
398
248
 
399
- * Fix eager loading for models without primary keys.
400
-
401
- *Anmol Chopra*, *Matt Lawrence*, and *Jonathan Hefner*
402
-
403
- * `rails db:schema:{dump,load}` now checks `ENV["SCHEMA_FORMAT"]` before config
404
-
405
- Since `rails db:structure:{dump,load}` was deprecated there wasn't a simple
406
- way to dump a schema to both SQL and Ruby formats. You can now do this with
407
- an environment variable. For example:
249
+ * Deprecate `name` argument on `#remove_connection`.
408
250
 
409
- ```
410
- SCHEMA_FORMAT=sql rake db:schema:dump
411
- ```
251
+ The `name` argument is deprecated on `#remove_connection` without replacement. `#remove_connection` should be called directly on the class that established the connection.
412
252
 
413
- *Alex Ghiculescu*
414
-
415
- * Fix Hstore deserialize regression.
416
-
417
- *edsharp*
253
+ *Eileen M. Uchitelle*
418
254
 
255
+ * Fix has_one through singular building with inverse.
419
256
 
420
- ## Rails 7.0.3.1 (July 12, 2022) ##
257
+ Allows building of records from an association with a has_one through a
258
+ singular association with inverse. For belongs_to through associations,
259
+ linking the foreign key to the primary key model isn't needed.
260
+ For has_one, we cannot build records due to the association not being mutable.
421
261
 
422
- * Change ActiveRecord::Coders::YAMLColumn default to safe_load
262
+ *Gannon McGibbon*
423
263
 
424
- This adds two new configuration options The configuration options are as
425
- follows:
264
+ * Disable database prepared statements when query logs are enabled
426
265
 
427
- * `config.active_record.use_yaml_unsafe_load`
266
+ Prepared Statements and Query Logs are incompatible features due to query logs making every query unique.
428
267
 
429
- When set to true, this configuration option tells Rails to use the old
430
- "unsafe" YAML loading strategy, maintaining the existing behavior but leaving
431
- the possible escalation vulnerability in place. Setting this option to true
432
- is *not* recommended, but can aid in upgrading.
268
+ *zzak, Jean Boussier*
433
269
 
434
- * `config.active_record.yaml_column_permitted_classes`
270
+ * Support decrypting data encrypted non-deterministically with a SHA1 hash digest.
435
271
 
436
- The "safe YAML" loading method does not allow all classes to be deserialized
437
- by default. This option allows you to specify classes deemed "safe" in your
438
- application. For example, if your application uses Symbol and Time in
439
- serialized data, you can add Symbol and Time to the allowed list as follows:
272
+ This adds a new Active Record encryption option to support decrypting data encrypted
273
+ non-deterministically with a SHA1 hash digest:
440
274
 
441
275
  ```
442
- config.active_record.yaml_column_permitted_classes = [Symbol, Date, Time]
276
+ Rails.application.config.active_record.encryption.support_sha1_for_non_deterministic_encryption = true
443
277
  ```
444
278
 
445
- [CVE-2022-32224]
446
-
447
-
448
- ## Rails 7.0.3 (May 09, 2022) ##
449
-
450
- * Some internal housekeeping on reloads could break custom `respond_to?`
451
- methods in class objects that referenced reloadable constants. See
452
- [#44125](https://github.com/rails/rails/issues/44125) for details.
453
-
454
- *Xavier Noria*
455
-
456
- * Fixed MariaDB default function support.
457
-
458
- Defaults would be written wrong in "db/schema.rb" and not work correctly
459
- if using `db:schema:load`. Further more the function name would be
460
- added as string content when saving new records.
461
-
462
- *kaspernj*
463
-
464
- * Fix `remove_foreign_key` with `:if_exists` option when foreign key actually exists.
279
+ The new option addresses a problem when upgrading from 7.0 to 7.1. Due to a bug in how Active Record
280
+ Encryption was getting initialized, the key provider used for non-deterministic encryption were using
281
+ SHA-1 as its digest class, instead of the one configured globally by Rails via
282
+ `Rails.application.config.active_support.key_generator_hash_digest_class`.
465
283
 
466
- *fatkodima*
284
+ *Cadu Ribeiro and Jorge Manrubia*
467
285
 
468
- * Remove `--no-comments` flag in structure dumps for PostgreSQL
286
+ * Added PostgreSQL migration commands for enum rename, add value, and rename value.
469
287
 
470
- This broke some apps that used custom schema comments. If you don't want
471
- comments in your structure dump, you can use:
288
+ `rename_enum` and `rename_enum_value` are reversible. Due to Postgres
289
+ limitation, `add_enum_value` is not reversible since you cannot delete enum
290
+ values. As an alternative you should drop and recreate the enum entirely.
472
291
 
473
292
  ```ruby
474
- ActiveRecord::Tasks::DatabaseTasks.structure_dump_flags = ['--no-comments']
293
+ rename_enum :article_status, to: :article_state
475
294
  ```
476
295
 
477
- *Alex Ghiculescu*
296
+ ```ruby
297
+ add_enum_value :article_state, "archived" # will be at the end of existing values
298
+ add_enum_value :article_state, "in review", before: "published"
299
+ add_enum_value :article_state, "approved", after: "in review"
300
+ ```
478
301
 
479
- * Use the model name as a prefix when filtering encrypted attributes from logs.
302
+ ```ruby
303
+ rename_enum_value :article_state, from: "archived", to: "deleted"
304
+ ```
480
305
 
481
- For example, when encrypting `Person#name` it will add `person.name` as a filter
482
- parameter, instead of just `name`. This prevents unintended filtering of parameters
483
- with a matching name in other models.
306
+ *Ray Faddis*
484
307
 
485
- *Jorge Manrubia*
308
+ * Allow composite primary key to be derived from schema
486
309
 
487
- * Fix quoting of `ActiveSupport::Duration` and `Rational` numbers in the MySQL adapter.
310
+ Booting an application with a schema that contains composite primary keys
311
+ will not issue warning and won't `nil`ify the `ActiveRecord::Base#primary_key` value anymore.
488
312
 
489
- *Kevin McPhillips*
313
+ Given a `travel_routes` table definition and a `TravelRoute` model like:
314
+ ```ruby
315
+ create_table :travel_routes, primary_key: [:origin, :destination], force: true do |t|
316
+ t.string :origin
317
+ t.string :destination
318
+ end
490
319
 
491
- * Fix `change_column_comment` to preserve column's AUTO_INCREMENT in the MySQL adapter
320
+ class TravelRoute < ActiveRecord::Base; end
321
+ ```
322
+ The `TravelRoute.primary_key` value will be automatically derived to `["origin", "destination"]`
492
323
 
493
- *fatkodima*
324
+ *Nikita Vasilevsky*
494
325
 
495
- ## Rails 7.0.2.4 (April 26, 2022) ##
326
+ * Include the `connection_pool` with exceptions raised from an adapter.
496
327
 
497
- * No changes.
328
+ The `connection_pool` provides added context such as the connection used
329
+ that led to the exception as well as which role and shard.
498
330
 
331
+ *Luan Vieira*
499
332
 
500
- ## Rails 7.0.2.3 (March 08, 2022) ##
333
+ * Support multiple column ordering for `find_each`, `find_in_batches` and `in_batches`.
501
334
 
502
- * No changes.
335
+ When find_each/find_in_batches/in_batches are performed on a table with composite primary keys, ascending or descending order can be selected for each key.
503
336
 
337
+ ```ruby
338
+ Person.find_each(order: [:desc, :asc]) do |person|
339
+ person.party_all_night!
340
+ end
341
+ ```
504
342
 
505
- ## Rails 7.0.2.2 (February 11, 2022) ##
343
+ *Takuya Kurimoto*
506
344
 
507
- * No changes.
345
+ * Fix where on association with has_one/has_many polymorphic relations.
508
346
 
347
+ Before:
348
+ ```ruby
349
+ Treasure.where(price_estimates: PriceEstimate.all)
350
+ #=> SELECT (...) WHERE "treasures"."id" IN (SELECT "price_estimates"."estimate_of_id" FROM "price_estimates")
351
+ ```
509
352
 
510
- ## Rails 7.0.2.1 (February 11, 2022) ##
353
+ Later:
354
+ ```ruby
355
+ Treasure.where(price_estimates: PriceEstimate.all)
356
+ #=> SELECT (...) WHERE "treasures"."id" IN (SELECT "price_estimates"."estimate_of_id" FROM "price_estimates" WHERE "price_estimates"."estimate_of_type" = 'Treasure')
357
+ ```
511
358
 
512
- * No changes.
359
+ *Lázaro Nixon*
513
360
 
361
+ * Assign auto populated columns on Active Record record creation.
514
362
 
515
- ## Rails 7.0.2 (February 08, 2022) ##
363
+ Changes record creation logic to allow for the `auto_increment` column to be assigned
364
+ immediately after creation regardless of it's relation to the model's primary key.
516
365
 
517
- * Fix `PG.connect` keyword arguments deprecation warning on ruby 2.7.
366
+ The PostgreSQL adapter benefits the most from the change allowing for any number of auto-populated
367
+ columns to be assigned on the object immediately after row insertion utilizing the `RETURNING` statement.
518
368
 
519
369
  *Nikita Vasilevsky*
520
370
 
521
- * Fix the ability to exclude encryption params from being autofiltered.
522
-
523
- *Mark Gangl*
524
-
525
- * Dump the precision for datetime columns following the new defaults.
526
-
527
- *Rafael Mendonça França*
528
-
529
- * Make sure encrypted attributes are not being filtered twice.
530
-
531
- *Nikita Vasilevsky*
371
+ * Use the first key in the `shards` hash from `connected_to` for the `default_shard`.
532
372
 
533
- * Dump the database schema containing the current Rails version.
373
+ Some applications may not want to use `:default` as a shard name in their connection model. Unfortunately Active Record expects there to be a `:default` shard because it must assume a shard to get the right connection from the pool manager. Rather than force applications to manually set this, `connects_to` can infer the default shard name from the hash of shards and will now assume that the first shard is your default.
534
374
 
535
- Since https://github.com/rails/rails/pull/42297, Rails now generate datetime columns
536
- with a default precision of 6. This means that users upgrading to Rails 7.0 from 6.1,
537
- when loading the database schema, would get the new precision value, which would not match
538
- the production schema.
375
+ For example if your model looked like this:
539
376
 
540
- To avoid this the schema dumper will generate the new format which will include the Rails
541
- version and will look like this:
377
+ ```ruby
378
+ class ShardRecord < ApplicationRecord
379
+ self.abstract_class = true
542
380
 
543
- ```
544
- ActiveRecord::Schema[7.0].define
381
+ connects_to shards: {
382
+ shard_one: { writing: :shard_one },
383
+ shard_two: { writing: :shard_two }
384
+ }
545
385
  ```
546
386
 
547
- When upgrading from Rails 6.1 to Rails 7.0, you can run the `rails app:update` task that will
548
- set the current schema version to 6.1.
387
+ Then the `default_shard` for this class would be set to `shard_one`.
549
388
 
550
- *Rafael Mendonça França*
389
+ Fixes: #45390
551
390
 
552
- * Fix parsing expression for PostgreSQL generated column.
391
+ *Eileen M. Uchitelle*
553
392
 
554
- *fatkodima*
393
+ * Fix mutation detection for serialized attributes backed by binary columns.
555
394
 
556
- * Fix `Mysql2::Error: Commands out of sync; you can't run this command now`
557
- when bulk-inserting fixtures that exceed `max_allowed_packet` configuration.
395
+ *Jean Boussier*
558
396
 
559
- *Nikita Vasilevsky*
397
+ * Add `ActiveRecord.disconnect_all!` method to immediately close all connections from all pools.
560
398
 
561
- * Fix error when saving an association with a relation named `record`.
399
+ *Jean Boussier*
562
400
 
563
- *Dorian Marié*
401
+ * Discard connections which may have been left in a transaction.
564
402
 
565
- * Fix `MySQL::SchemaDumper` behavior about datetime precision value.
403
+ There are cases where, due to an error, `within_new_transaction` may unexpectedly leave a connection in an open transaction. In these cases the connection may be reused, and the following may occur:
404
+ - Writes appear to fail when they actually succeed.
405
+ - Writes appear to succeed when they actually fail.
406
+ - Reads return stale or uncommitted data.
566
407
 
567
- *y0t4*
408
+ Previously, the following case was detected:
409
+ - An error is encountered during the transaction, then another error is encountered while attempting to roll it back.
568
410
 
569
- * Improve associated with no reflection error.
411
+ Now, the following additional cases are detected:
412
+ - An error is encountered just after successfully beginning a transaction.
413
+ - An error is encountered while committing a transaction, then another error is encountered while attempting to roll it back.
414
+ - An error is encountered while rolling back a transaction.
570
415
 
571
- *Nikolai*
416
+ *Nick Dower*
572
417
 
573
- * Fix PG.connect keyword arguments deprecation warning on ruby 2.7.
418
+ * Active Record query cache now evicts least recently used entries
574
419
 
575
- Fixes #44307.
420
+ By default it only keeps the `100` most recently used queries.
576
421
 
577
- *Nikita Vasilevsky*
578
-
579
- * Fix passing options to `check_constraint` from `change_table`.
580
-
581
- *Frederick Cheung*
422
+ The cache size can be configured via `database.yml`
582
423
 
424
+ ```yaml
425
+ development:
426
+ adapter: mysql2
427
+ query_cache: 200
428
+ ```
583
429
 
584
- ## Rails 7.0.1 (January 06, 2022) ##
430
+ It can also be entirely disabled:
585
431
 
432
+ ```yaml
433
+ development:
434
+ adapter: mysql2
435
+ query_cache: false
436
+ ```
586
437
 
587
- * Change `QueryMethods#in_order_of` to drop records not listed in values.
438
+ *Jean Boussier*
588
439
 
589
- `in_order_of` now filters down to the values provided, to match the behavior of the `Enumerable` version.
440
+ * Deprecate `check_pending!` in favor of `check_all_pending!`.
590
441
 
591
- *Kevin Newton*
442
+ `check_pending!` will only check for pending migrations on the current database connection or the one passed in. This has been deprecated in favor of `check_all_pending!` which will find all pending migrations for the database configurations in a given environment.
592
443
 
593
- * Allow named expression indexes to be revertible.
444
+ *Eileen M. Uchitelle*
594
445
 
595
- Previously, the following code would raise an error in a reversible migration executed while rolling back, due to the index name not being used in the index removal.
446
+ * Make `increment_counter`/`decrement_counter` accept an amount argument
596
447
 
597
448
  ```ruby
598
- add_index(:settings, "(data->'property')", using: :gin, name: :index_settings_data_property)
449
+ Post.increment_counter(:comments_count, 5, by: 3)
599
450
  ```
600
451
 
601
- Fixes #43331.
602
-
603
- *Oliver Günther*
452
+ *fatkodima*
604
453
 
605
- * Better error messages when association name is invalid in the argument of `ActiveRecord::QueryMethods::WhereChain#missing`.
454
+ * Add support for `Array#intersect?` to `ActiveRecord::Relation`.
606
455
 
607
- *ykpythemind*
456
+ `Array#intersect?` is only available on Ruby 3.1 or later.
608
457
 
609
- * Fix ordered migrations for single db in multi db environment.
458
+ This allows the Rubocop `Style/ArrayIntersect` cop to work with `ActiveRecord::Relation` objects.
610
459
 
611
- *Himanshu*
460
+ *John Harry Kelly*
612
461
 
613
- * Extract `on update CURRENT_TIMESTAMP` for mysql2 adapter.
462
+ * The deferrable foreign key can be passed to `t.references`.
614
463
 
615
- *Kazuhiro Masuda*
464
+ *Hiroyuki Ishii*
616
465
 
617
- * Fix incorrect argument in PostgreSQL structure dump tasks.
466
+ * Deprecate `deferrable: true` option of `add_foreign_key`.
618
467
 
619
- Updating the `--no-comment` argument added in Rails 7 to the correct `--no-comments` argument.
468
+ `deferrable: true` is deprecated in favor of `deferrable: :immediate`, and
469
+ will be removed in Rails 7.2.
620
470
 
621
- *Alex Dent*
471
+ Because `deferrable: true` and `deferrable: :deferred` are hard to understand.
472
+ Both true and :deferred are truthy values.
473
+ This behavior is the same as the deferrable option of the add_unique_key method, added in #46192.
622
474
 
623
- * Fix schema dumping column default SQL values for sqlite3.
475
+ *Hiroyuki Ishii*
624
476
 
625
- *fatkodima*
477
+ * `AbstractAdapter#execute` and `#exec_query` now clear the query cache
626
478
 
627
- * Correctly parse complex check constraint expressions for PostgreSQL.
479
+ If you need to perform a read only SQL query without clearing the query
480
+ cache, use `AbstractAdapter#select_all`.
628
481
 
629
- *fatkodima*
482
+ *Jean Boussier*
630
483
 
631
- * Fix `timestamptz` attributes on PostgreSQL handle blank inputs.
484
+ * Make `.joins` / `.left_outer_joins` work with CTEs.
632
485
 
633
- *Alex Ghiculescu*
486
+ For example:
634
487
 
635
- * Fix migration compatibility to create SQLite references/belongs_to column as integer when migration version is 6.0.
488
+ ```ruby
489
+ Post
490
+ .with(commented_posts: Comment.select(:post_id).distinct)
491
+ .joins(:commented_posts)
492
+ #=> WITH (...) SELECT ... INNER JOIN commented_posts on posts.id = commented_posts.post_id
493
+ ```
636
494
 
637
- Reference/belongs_to in migrations with version 6.0 were creating columns as
638
- bigint instead of integer for the SQLite Adapter.
495
+ *Vladimir Dementyev*
639
496
 
640
- *Marcelo Lauxen*
497
+ * Add a load hook for `ActiveRecord::ConnectionAdapters::Mysql2Adapter`
498
+ (named `active_record_mysql2adapter`) to allow for overriding aspects of the
499
+ `ActiveRecord::ConnectionAdapters::Mysql2Adapter` class. This makes `Mysql2Adapter`
500
+ consistent with `PostgreSQLAdapter` and `SQLite3Adapter` that already have load hooks.
641
501
 
642
- * Fix joining through a polymorphic association.
502
+ *fatkodima*
643
503
 
644
- *Alexandre Ruban*
504
+ * Introduce adapter for Trilogy database client
645
505
 
646
- * Fix `QueryMethods#in_order_of` to handle empty order list.
506
+ Trilogy is a MySQL-compatible database client. Rails applications can use Trilogy
507
+ by configuring their `config/database.yml`:
647
508
 
648
- ```ruby
649
- Post.in_order_of(:id, []).to_a
509
+ ```yaml
510
+ development:
511
+ adapter: trilogy
512
+ database: blog_development
513
+ pool: 5
650
514
  ```
651
515
 
652
- Also more explicitly set the column as secondary order, so that any other
653
- value is still ordered.
654
-
655
- *Jean Boussier*
656
-
657
- * Fix `rails dbconsole` for 3-tier config.
516
+ Or by using the `DATABASE_URL` environment variable:
658
517
 
659
- *Eileen M. Uchitelle*
518
+ ```ruby
519
+ ENV['DATABASE_URL'] # => "trilogy://localhost/blog_development?pool=5"
520
+ ```
660
521
 
661
- * Fix quoting of column aliases generated by calculation methods.
522
+ *Adrianna Chang*
662
523
 
663
- Since the alias is derived from the table name, we can't assume the result
664
- is a valid identifier.
524
+ * `after_commit` callbacks defined on models now execute in the correct order.
665
525
 
666
526
  ```ruby
667
- class Test < ActiveRecord::Base
668
- self.table_name = '1abc'
527
+ class User < ActiveRecord::Base
528
+ after_commit { puts("this gets called first") }
529
+ after_commit { puts("this gets called second") }
669
530
  end
670
- Test.group(:id).count
671
- # syntax error at or near "1" (ActiveRecord::StatementInvalid)
672
- # LINE 1: SELECT COUNT(*) AS count_all, "1abc"."id" AS 1abc_id FROM "1...
673
531
  ```
674
532
 
675
- *Jean Boussier*
533
+ Previously, the callbacks executed in the reverse order. To opt in to the new behaviour:
534
+
535
+ ```ruby
536
+ config.active_record.run_after_transaction_callbacks_in_order_defined = true
537
+ ```
676
538
 
539
+ This is the default for new apps.
677
540
 
678
- ## Rails 7.0.0 (December 15, 2021) ##
541
+ *Alex Ghiculescu*
679
542
 
680
- * Better handle SQL queries with invalid encoding.
543
+ * Infer `foreign_key` when `inverse_of` is present on `has_one` and `has_many` associations.
681
544
 
682
545
  ```ruby
683
- Post.create(name: "broken \xC8 UTF-8")
546
+ has_many :citations, foreign_key: "book1_id", inverse_of: :book
684
547
  ```
685
548
 
686
- Would cause all adapters to fail in a non controlled way in the code
687
- responsible to detect write queries.
549
+ can be simplified to
688
550
 
689
- The query is now properly passed to the database connection, which might or might
690
- not be able to handle it, but will either succeed or failed in a more correct way.
691
-
692
- *Jean Boussier*
551
+ ```ruby
552
+ has_many :citations, inverse_of: :book
553
+ ```
693
554
 
694
- * Move database and shard selection config options to a generator.
555
+ and the foreign_key will be read from the corresponding `belongs_to` association.
695
556
 
696
- Rather than generating the config options in `production.rb` when applications are created, applications can now run a generator to create an initializer and uncomment / update options as needed. All multi-db configuration can be implemented in this initializer.
557
+ *Daniel Whitney*
697
558
 
698
- *Eileen M. Uchitelle*
559
+ * Limit max length of auto generated index names
699
560
 
561
+ Auto generated index names are now limited to 62 bytes, which fits within
562
+ the default index name length limits for MySQL, Postgres and SQLite.
700
563
 
701
- ## Rails 7.0.0.rc3 (December 14, 2021) ##
564
+ Any index name over the limit will fallback to the new short format.
702
565
 
703
- * No changes.
566
+ Before (too long):
567
+ ```
568
+ index_testings_on_foo_and_bar_and_first_name_and_last_name_and_administrator
569
+ ```
704
570
 
571
+ After (short format):
572
+ ```
573
+ idx_on_foo_bar_first_name_last_name_administrator_5939248142
574
+ ```
705
575
 
706
- ## Rails 7.0.0.rc2 (December 14, 2021) ##
576
+ The short format includes a hash to ensure the name is unique database-wide.
707
577
 
708
- * No changes.
578
+ *Mike Coutermarsh*
709
579
 
580
+ * Introduce a more stable and optimized Marshal serializer for Active Record models.
710
581
 
711
- ## Rails 7.0.0.rc1 (December 06, 2021) ##
582
+ Can be enabled with `config.active_record.marshalling_format_version = 7.1`.
712
583
 
713
- * Remove deprecated `ActiveRecord::DatabaseConfigurations::DatabaseConfig#spec_name`.
584
+ *Jean Boussier*
714
585
 
715
- *Rafael Mendonça França*
586
+ * Allow specifying where clauses with column-tuple syntax.
716
587
 
717
- * Remove deprecated `ActiveRecord::Connection#in_clause_length`.
588
+ Querying through `#where` now accepts a new tuple-syntax which accepts, as
589
+ a key, an array of columns and, as a value, an array of corresponding tuples.
590
+ The key specifies a list of columns, while the value is an array of
591
+ ordered-tuples that conform to the column list.
718
592
 
719
- *Rafael Mendonça França*
593
+ For instance:
720
594
 
721
- * Remove deprecated `ActiveRecord::Connection#allowed_index_name_length`.
595
+ ```ruby
596
+ # Cpk::Book => Cpk::Book(author_id: integer, number: integer, title: string, revision: integer)
597
+ # Cpk::Book.primary_key => ["author_id", "number"]
722
598
 
723
- *Rafael Mendonça França*
599
+ book = Cpk::Book.create!(author_id: 1, number: 1)
600
+ Cpk::Book.where(Cpk::Book.primary_key => [[1, 2]]) # => [book]
724
601
 
725
- * Remove deprecated `ActiveRecord::Base#remove_connection`.
602
+ # Topic => Topic(id: integer, title: string, author_name: string...)
726
603
 
727
- *Rafael Mendonça França*
604
+ Topic.where([:title, :author_name] => [["The Alchemist", "Paul Coelho"], ["Harry Potter", "J.K Rowling"]])
605
+ ```
728
606
 
729
- * Load STI Models in fixtures
607
+ *Paarth Madan*
730
608
 
731
- Data from Fixtures now loads based on the specific class for models with
732
- Single Table Inheritance. This affects enums defined in subclasses, previously
733
- the value of these fields was not parsed and remained `nil`
609
+ * Allow warning codes to be ignore when reporting SQL warnings.
734
610
 
735
- *Andres Howard*
611
+ Active Record config that can ignore warning codes
736
612
 
737
- * `#authenticate` returns false when the password is blank instead of raising an error.
613
+ ```ruby
614
+ # Configure allowlist of warnings that should always be ignored
615
+ config.active_record.db_warnings_ignore = [
616
+ "1062", # MySQL Error 1062: Duplicate entry
617
+ ]
618
+ ```
738
619
 
739
- *Muhammad Muhammad Ibrahim*
620
+ This is supported for the MySQL and PostgreSQL adapters.
740
621
 
741
- * Fix `ActiveRecord::QueryMethods#in_order_of` behavior for integer enums.
622
+ *Nick Borromeo*
742
623
 
743
- `ActiveRecord::QueryMethods#in_order_of` didn't work as expected for enums stored as integers in the database when passing an array of strings or symbols as the order argument. This unexpected behavior occurred because the string or symbol values were not casted to match the integers in the database.
624
+ * Introduce `:active_record_fixtures` lazy load hook.
744
625
 
745
- The following example now works as expected:
626
+ Hooks defined with this name will be run whenever `TestFixtures` is included
627
+ in a class.
746
628
 
747
629
  ```ruby
748
- class Book < ApplicationRecord
749
- enum status: [:proposed, :written, :published]
630
+ ActiveSupport.on_load(:active_record_fixtures) do
631
+ self.fixture_paths << "test/fixtures"
750
632
  end
751
633
 
752
- Book.in_order_of(:status, %w[written published proposed])
753
- ```
754
-
755
- *Alexandre Ruban*
634
+ klass = Class.new
635
+ klass.include(ActiveRecord::TestFixtures)
756
636
 
757
- * Ignore persisted in-memory records when merging target lists.
637
+ klass.fixture_paths # => ["test/fixtures"]
638
+ ```
758
639
 
759
- *Kevin Sjöberg*
640
+ *Andrew Novoselac*
760
641
 
761
- * Add a new option `:update_only` to `upsert_all` to configure the list of columns to update in case of conflict.
642
+ * Introduce `TestFixtures#fixture_paths`.
762
643
 
763
- Before, you could only customize the update SQL sentence via `:on_duplicate`. There is now a new option `:update_only` that lets you provide a list of columns to update in case of conflict:
644
+ Multiple fixture paths can now be specified using the `#fixture_paths` accessor.
645
+ Apps will continue to have `test/fixtures` as their one fixture path by default,
646
+ but additional fixture paths can be specified.
764
647
 
765
648
  ```ruby
766
- Commodity.upsert_all(
767
- [
768
- { id: 2, name: "Copper", price: 4.84 },
769
- { id: 4, name: "Gold", price: 1380.87 },
770
- { id: 6, name: "Aluminium", price: 0.35 }
771
- ],
772
- update_only: [:price] # Only prices will be updated
773
- )
649
+ ActiveSupport::TestCase.fixture_paths << "component1/test/fixtures"
650
+ ActiveSupport::TestCase.fixture_paths << "component2/test/fixtures"
774
651
  ```
775
652
 
776
- *Jorge Manrubia*
653
+ `TestFixtures#fixture_path` is now deprecated.
777
654
 
778
- * Remove deprecated `ActiveRecord::Result#map!` and `ActiveRecord::Result#collect!`.
779
-
780
- *Rafael Mendonça França*
655
+ *Andrew Novoselac*
781
656
 
782
- * Remove deprecated `ActiveRecord::Base.configurations.to_h`.
657
+ * Adds support for deferrable exclude constraints in PostgreSQL.
783
658
 
784
- *Rafael Mendonça França*
659
+ By default, exclude constraints in PostgreSQL are checked after each statement.
660
+ This works for most use cases, but becomes a major limitation when replacing
661
+ records with overlapping ranges by using multiple statements.
785
662
 
786
- * Remove deprecated `ActiveRecord::Base.configurations.default_hash`.
663
+ ```ruby
664
+ exclusion_constraint :users, "daterange(valid_from, valid_to) WITH &&", deferrable: :immediate
665
+ ```
787
666
 
788
- *Rafael Mendonça França*
667
+ Passing `deferrable: :immediate` checks constraint after each statement,
668
+ but allows manually deferring the check using `SET CONSTRAINTS ALL DEFERRED`
669
+ within a transaction. This will cause the excludes to be checked after the transaction.
789
670
 
790
- * Remove deprecated `ActiveRecord::Base.arel_attribute`.
671
+ It's also possible to change the default behavior from an immediate check
672
+ (after the statement), to a deferred check (after the transaction):
791
673
 
792
- *Rafael Mendonça França*
674
+ ```ruby
675
+ exclusion_constraint :users, "daterange(valid_from, valid_to) WITH &&", deferrable: :deferred
676
+ ```
793
677
 
794
- * Remove deprecated `ActiveRecord::Base.connection_config`.
678
+ *Hiroyuki Ishii*
795
679
 
796
- *Rafael Mendonça França*
680
+ * Respect `foreign_type` option to `delegated_type` for `{role}_class` method.
797
681
 
798
- * Filter attributes in SQL logs
682
+ Usage of `delegated_type` with non-conventional `{role}_type` column names can now be specified with `foreign_type` option.
683
+ This option is the same as `foreign_type` as forwarded to the underlying `belongs_to` association that `delegated_type` wraps.
799
684
 
800
- Previously, SQL queries in logs containing `ActiveRecord::Base.filter_attributes` were not filtered.
685
+ *Jason Karns*
801
686
 
802
- Now, the filter attributes will be masked `[FILTERED]` in the logs when `prepared_statement` is enabled.
687
+ * Add support for unique constraints (PostgreSQL-only).
803
688
 
689
+ ```ruby
690
+ add_unique_key :sections, [:position], deferrable: :deferred, name: "unique_section_position"
691
+ remove_unique_key :sections, name: "unique_section_position"
804
692
  ```
805
- # Before:
806
- Foo Load (0.2ms) SELECT "foos".* FROM "foos" WHERE "foos"."passw" = ? LIMIT ? [["passw", "hello"], ["LIMIT", 1]]
807
693
 
808
- # After:
809
- Foo Load (0.5ms) SELECT "foos".* FROM "foos" WHERE "foos"."passw" = ? LIMIT ? [["passw", "[FILTERED]"], ["LIMIT", 1]]
694
+ See PostgreSQL's [Unique Constraints](https://www.postgresql.org/docs/current/ddl-constraints.html#DDL-CONSTRAINTS-UNIQUE-CONSTRAINTS) documentation for more on unique constraints.
695
+
696
+ By default, unique constraints in PostgreSQL are checked after each statement.
697
+ This works for most use cases, but becomes a major limitation when replacing
698
+ records with unique column by using multiple statements.
699
+
700
+ An example of swapping unique columns between records.
701
+
702
+ ```ruby
703
+ # position is unique column
704
+ old_item = Item.create!(position: 1)
705
+ new_item = Item.create!(position: 2)
706
+
707
+ Item.transaction do
708
+ old_item.update!(position: 2)
709
+ new_item.update!(position: 1)
710
+ end
810
711
  ```
811
712
 
812
- *Aishwarya Subramanian*
713
+ Using the default behavior, the transaction would fail when executing the
714
+ first `UPDATE` statement.
813
715
 
814
- * Remove deprecated `Tasks::DatabaseTasks.spec`.
716
+ By passing the `:deferrable` option to the `add_unique_key` statement in
717
+ migrations, it's possible to defer this check.
815
718
 
816
- *Rafael Mendonça França*
719
+ ```ruby
720
+ add_unique_key :items, [:position], deferrable: :immediate
721
+ ```
817
722
 
818
- * Remove deprecated `Tasks::DatabaseTasks.current_config`.
723
+ Passing `deferrable: :immediate` does not change the behaviour of the previous example,
724
+ but allows manually deferring the check using `SET CONSTRAINTS ALL DEFERRED` within a transaction.
725
+ This will cause the unique constraints to be checked after the transaction.
819
726
 
820
- *Rafael Mendonça França*
727
+ It's also possible to adjust the default behavior from an immediate
728
+ check (after the statement), to a deferred check (after the transaction):
821
729
 
822
- * Deprecate `Tasks::DatabaseTasks.schema_file_type`.
730
+ ```ruby
731
+ add_unique_key :items, [:position], deferrable: :deferred
732
+ ```
823
733
 
824
- *Rafael Mendonça França*
734
+ If you want to change an existing unique index to deferrable, you can use :using_index
735
+ to create deferrable unique constraints.
825
736
 
826
- * Remove deprecated `Tasks::DatabaseTasks.dump_filename`.
737
+ ```ruby
738
+ add_unique_key :items, deferrable: :deferred, using_index: "index_items_on_position"
739
+ ```
827
740
 
828
- *Rafael Mendonça França*
741
+ *Hiroyuki Ishii*
829
742
 
830
- * Remove deprecated `Tasks::DatabaseTasks.schema_file`.
743
+ * Remove deprecated `Tasks::DatabaseTasks.schema_file_type`.
831
744
 
832
745
  *Rafael Mendonça França*
833
746
 
834
- * Remove deprecated `environment` and `name` arguments from `Tasks::DatabaseTasks.schema_up_to_date?`.
747
+ * Remove deprecated `config.active_record.partial_writes`.
835
748
 
836
749
  *Rafael Mendonça França*
837
750
 
838
- * Merging conditions on the same column no longer maintain both conditions,
839
- and will be consistently replaced by the latter condition.
840
-
841
- ```ruby
842
- # Rails 6.1 (IN clause is replaced by merger side equality condition)
843
- Author.where(id: [david.id, mary.id]).merge(Author.where(id: bob)) # => [bob]
844
- # Rails 6.1 (both conflict conditions exists, deprecated)
845
- Author.where(id: david.id..mary.id).merge(Author.where(id: bob)) # => []
846
- # Rails 6.1 with rewhere to migrate to Rails 7.0's behavior
847
- Author.where(id: david.id..mary.id).merge(Author.where(id: bob), rewhere: true) # => [bob]
848
- # Rails 7.0 (same behavior with IN clause, mergee side condition is consistently replaced)
849
- Author.where(id: [david.id, mary.id]).merge(Author.where(id: bob)) # => [bob]
850
- Author.where(id: david.id..mary.id).merge(Author.where(id: bob)) # => [bob]
751
+ * Remove deprecated `ActiveRecord::Base` config accessors.
851
752
 
852
753
  *Rafael Mendonça França*
853
754
 
854
- * Remove deprecated support to `Model.reorder(nil).first` to search using non-deterministic order.
755
+ * Remove the `:include_replicas` argument from `configs_for`. Use `:include_hidden` argument instead.
855
756
 
856
- *Rafael Mendonça França*
757
+ *Eileen M. Uchitelle*
857
758
 
858
- * Remove deprecated rake tasks:
759
+ * Allow applications to lookup a config via a custom hash key.
859
760
 
860
- * `db:schema:load_if_ruby`
861
- * `db:structure:dump`
862
- * `db:structure:load`
863
- * `db:structure:load_if_sql`
864
- * `db:structure:dump:#{name}`
865
- * `db:structure:load:#{name}`
866
- * `db:test:load_structure`
867
- * `db:test:load_structure:#{name}`
761
+ If you have registered a custom config or want to find configs where the hash matches a specific key, now you can pass `config_key` to `configs_for`. For example if you have a `db_config` with the key `vitess` you can look up a database configuration hash by matching that key.
868
762
 
869
- *Rafael Mendonça França*
763
+ ```ruby
764
+ ActiveRecord::Base.configurations.configs_for(env_name: "development", name: "primary", config_key: :vitess)
765
+ ActiveRecord::Base.configurations.configs_for(env_name: "development", config_key: :vitess)
766
+ ```
767
+
768
+ *Eileen M. Uchitelle*
870
769
 
871
- * Remove deprecated `DatabaseConfig#config` method.
770
+ * Allow applications to register a custom database configuration handler.
872
771
 
873
- *Rafael Mendonça França*
772
+ Adds a mechanism for registering a custom handler for cases where you want database configurations to respond to custom methods. This is useful for non-Rails database adapters or tools like Vitess that you may want to configure differently from a standard `HashConfig` or `UrlConfig`.
874
773
 
875
- * Rollback transactions when the block returns earlier than expected.
774
+ Given the following database YAML we want the `animals` db to create a `CustomConfig` object instead while the `primary` database will be a `UrlConfig`:
876
775
 
877
- Before this change, when a transaction block returned early, the transaction would be committed.
776
+ ```yaml
777
+ development:
778
+ primary:
779
+ url: postgres://localhost/primary
780
+ animals:
781
+ url: postgres://localhost/animals
782
+ custom_config:
783
+ sharded: 1
784
+ ```
878
785
 
879
- The problem is that timeouts triggered inside the transaction block was also making the incomplete transaction
880
- to be committed, so in order to avoid this mistake, the transaction block is rolled back.
786
+ To register a custom handler first make a class that has your custom methods:
881
787
 
882
- *Rafael Mendonça França*
788
+ ```ruby
789
+ class CustomConfig < ActiveRecord::DatabaseConfigurations::UrlConfig
790
+ def sharded?
791
+ custom_config.fetch("sharded", false)
792
+ end
883
793
 
884
- * Add middleware for automatic shard swapping.
794
+ private
795
+ def custom_config
796
+ configuration_hash.fetch(:custom_config)
797
+ end
798
+ end
799
+ ```
885
800
 
886
- Provides a basic middleware to perform automatic shard swapping. Applications will provide a resolver which will determine for an individual request which shard should be used. Example:
801
+ Then register the config in an initializer:
887
802
 
888
803
  ```ruby
889
- config.active_record.shard_resolver = ->(request) {
890
- subdomain = request.subdomain
891
- tenant = Tenant.find_by_subdomain!(subdomain)
892
- tenant.shard
893
- }
804
+ ActiveRecord::DatabaseConfigurations.register_db_config_handler do |env_name, name, url, config|
805
+ next unless config.key?(:custom_config)
806
+ CustomConfig.new(env_name, name, url, config)
807
+ end
894
808
  ```
895
809
 
896
- See guides for more details.
810
+ When the application is booted, configuration hashes with the `:custom_config` key will be `CustomConfig` objects and respond to `sharded?`. Applications must handle the condition in which Active Record should use their custom handler.
897
811
 
898
- *Eileen M. Uchitelle*, *John Crepezzi*
812
+ *Eileen M. Uchitelle and John Crepezzi*
899
813
 
900
- * Remove deprecated support to pass a column to `type_cast`.
814
+ * `ActiveRecord::Base.serialize` no longer uses YAML by default.
901
815
 
902
- *Rafael Mendonça França*
816
+ YAML isn't particularly performant and can lead to security issues
817
+ if not used carefully.
903
818
 
904
- * Remove deprecated support to type cast to database values `ActiveRecord::Base` objects.
819
+ Unfortunately there isn't really any good serializers in Ruby's stdlib
820
+ to replace it.
905
821
 
906
- *Rafael Mendonça França*
822
+ The obvious choice would be JSON, which is a fine format for this use case,
823
+ however the JSON serializer in Ruby's stdlib isn't strict enough, as it fallback
824
+ to casting unknown types to strings, which could lead to corrupted data.
907
825
 
908
- * Remove deprecated support to quote `ActiveRecord::Base` objects.
826
+ Some third party JSON libraries like `Oj` have a suitable strict mode.
909
827
 
910
- *Rafael Mendonça França*
828
+ So it's preferable that users choose a serializer based on their own constraints.
911
829
 
912
- * Remove deprecacated support to resolve connection using `"primary"` as connection specification name.
830
+ The original default can be restored by setting `config.active_record.default_column_serializer = YAML`.
913
831
 
914
- *Rafael Mendonça França*
832
+ *Jean Boussier*
915
833
 
916
- * Remove deprecation warning when using `:interval` column is used in PostgreSQL database.
834
+ * `ActiveRecord::Base.serialize` signature changed.
917
835
 
918
- Now, interval columns will return `ActiveSupport::Duration` objects instead of strings.
836
+ Rather than a single positional argument that accepts two possible
837
+ types of values, `serialize` now accepts two distinct keyword arguments.
919
838
 
920
- To keep the old behavior, you can add this line to your model:
839
+ Before:
921
840
 
922
841
  ```ruby
923
- attribute :column, :string
842
+ serialize :content, JSON
843
+ serialize :backtrace, Array
924
844
  ```
925
845
 
926
- *Rafael Mendonça França*
927
-
928
- * Remove deprecated support to YAML load `ActiveRecord::Base` instance in the Rails 4.2 and 4.1 formats.
846
+ After:
929
847
 
930
- *Rafael Mendonça França*
848
+ ```ruby
849
+ serialize :content, coder: JSON
850
+ serialize :backtrace, type: Array
851
+ ```
931
852
 
932
- * Remove deprecated option `:spec_name` in the `configs_for` method.
853
+ *Jean Boussier*
933
854
 
934
- *Rafael Mendonça França*
855
+ * YAML columns use `YAML.safe_dump` is available.
935
856
 
936
- * Remove deprecated `ActiveRecord::Base.allow_unsafe_raw_sql`.
857
+ As of `psych 5.1.0`, `YAML.safe_dump` can now apply the same permitted
858
+ types restrictions than `YAML.safe_load`.
937
859
 
938
- *Rafael Mendonça França*
860
+ It's preferable to ensure the payload only use allowed types when we first
861
+ try to serialize it, otherwise you may end up with invalid records in the
862
+ database.
939
863
 
940
- * Fix regression bug that caused ignoring additional conditions for preloading has_many-through relations.
864
+ *Jean Boussier*
941
865
 
942
- Fixes #43132
866
+ * `ActiveRecord::QueryLogs` better handle broken encoding.
943
867
 
944
- *Alexander Pauly*
868
+ It's not uncommon when building queries with BLOB fields to contain
869
+ binary data. Unless the call carefully encode the string in ASCII-8BIT
870
+ it generally end up being encoded in `UTF-8`, and `QueryLogs` would
871
+ end up failing on it.
945
872
 
946
- * Fix `has_many` inversing recursion on models with recursive associations.
873
+ `ActiveRecord::QueryLogs` no longer depend on the query to be properly encoded.
947
874
 
948
- *Gannon McGibbon*
875
+ *Jean Boussier*
949
876
 
950
- * Add `accepts_nested_attributes_for` support for `delegated_type`
877
+ * Fix a bug where `ActiveRecord::Generators::ModelGenerator` would not respect create_table_migration template overrides.
951
878
 
952
- ```ruby
953
- class Entry < ApplicationRecord
954
- delegated_type :entryable, types: %w[ Message Comment ]
955
- accepts_nested_attributes_for :entryable
956
- end
879
+ ```
880
+ rails g model create_books title:string content:text
881
+ ```
882
+ will now read from the create_table_migration.rb.tt template in the following locations in order:
883
+ ```
884
+ lib/templates/active_record/model/create_table_migration.rb
885
+ lib/templates/active_record/migration/create_table_migration.rb
886
+ ```
957
887
 
958
- entry = Entry.create(entryable_type: 'Message', entryable_attributes: { content: 'Hello world' })
959
- # => #<Entry:0x00>
960
- # id: 1
961
- # entryable_id: 1,
962
- # entryable_type: 'Message'
963
- # ...>
888
+ *Spencer Neste*
964
889
 
965
- entry.entryable
966
- # => #<Message:0x01>
967
- # id: 1
968
- # content: 'Hello world'
969
- # ...>
970
- ```
890
+ * `ActiveRecord::Relation#explain` now accepts options.
971
891
 
972
- Previously it would raise an error:
892
+ For databases and adapters which support them (currently PostgreSQL
893
+ and MySQL), options can be passed to `explain` to provide more
894
+ detailed query plan analysis:
973
895
 
974
896
  ```ruby
975
- Entry.create(entryable_type: 'Message', entryable_attributes: { content: 'Hello world' })
976
- # ArgumentError: Cannot build association `entryable'. Are you trying to build a polymorphic one-to-one association?
897
+ Customer.where(id: 1).joins(:orders).explain(:analyze, :verbose)
977
898
  ```
978
899
 
979
- *Sjors Baltus*
980
-
981
- * Use subquery for DELETE with GROUP_BY and HAVING clauses.
900
+ *Reid Lynch*
982
901
 
983
- Prior to this change, deletes with GROUP_BY and HAVING were returning an error.
902
+ * Multiple `Arel::Nodes::SqlLiteral` nodes can now be added together to
903
+ form `Arel::Nodes::Fragments` nodes. This allows joining several pieces
904
+ of SQL.
984
905
 
985
- After this change, GROUP_BY and HAVING are valid clauses in DELETE queries, generating the following query:
906
+ *Matthew Draper*, *Ole Friis*
986
907
 
987
- ```sql
988
- DELETE FROM "posts" WHERE "posts"."id" IN (
989
- SELECT "posts"."id" FROM "posts" INNER JOIN "comments" ON "comments"."post_id" = "posts"."id" GROUP BY "posts"."id" HAVING (count(comments.id) >= 2))
990
- ) [["flagged", "t"]]
991
- ```
908
+ * `ActiveRecord::Base#signed_id` raises if called on a new record.
992
909
 
993
- *Ignacio Chiazzo Cardarello*
910
+ Previously it would return an ID that was not usable, since it was based on `id = nil`.
994
911
 
995
- * Use subquery for UPDATE with GROUP_BY and HAVING clauses.
912
+ *Alex Ghiculescu*
996
913
 
997
- Prior to this change, updates with GROUP_BY and HAVING were being ignored, generating a SQL like this:
914
+ * Allow SQL warnings to be reported.
998
915
 
999
- ```sql
1000
- UPDATE "posts" SET "flagged" = ? WHERE "posts"."id" IN (
1001
- SELECT "posts"."id" FROM "posts" INNER JOIN "comments" ON "comments"."post_id" = "posts"."id"
1002
- ) [["flagged", "t"]]
1003
- ```
916
+ Active Record configs can be set to enable SQL warning reporting.
1004
917
 
1005
- After this change, GROUP_BY and HAVING clauses are used as a subquery in updates, like this:
918
+ ```ruby
919
+ # Configure action to take when SQL query produces warning
920
+ config.active_record.db_warnings_action = :raise
1006
921
 
1007
- ```sql
1008
- UPDATE "posts" SET "flagged" = ? WHERE "posts"."id" IN (
1009
- SELECT "posts"."id" FROM "posts" INNER JOIN "comments" ON "comments"."post_id" = "posts"."id"
1010
- GROUP BY posts.id HAVING (count(comments.id) >= 2)
1011
- ) [["flagged", "t"]]
922
+ # Configure allowlist of warnings that should always be ignored
923
+ config.active_record.db_warnings_ignore = [
924
+ /Invalid utf8mb4 character string/,
925
+ "An exact warning message",
926
+ ]
1012
927
  ```
1013
928
 
1014
- *Ignacio Chiazzo Cardarello*
929
+ This is supported for the MySQL and PostgreSQL adapters.
1015
930
 
1016
- * Add support for setting the filename of the schema or structure dump in the database config.
931
+ *Adrianna Chang*, *Paarth Madan*
1017
932
 
1018
- Applications may now set their the filename or path of the schema / structure dump file in their database configuration.
933
+ * Add `#regroup` query method as a short-hand for `.unscope(:group).group(fields)`
1019
934
 
1020
- ```yaml
1021
- production:
1022
- primary:
1023
- database: my_db
1024
- schema_dump: my_schema_dump_filename.rb
1025
- animals:
1026
- database: animals_db
1027
- schema_dump: false
935
+ Example:
936
+
937
+ ```ruby
938
+ Post.group(:title).regroup(:author)
939
+ # SELECT `posts`.`*` FROM `posts` GROUP BY `posts`.`author`
1028
940
  ```
1029
941
 
1030
- The filename set in `schema_dump` will be used by the application. If set to `false` the schema will not be dumped. The database tasks are responsible for adding the database directory to the filename. If a full path is provided, the Rails tasks will use that instead of `ActiveRecord::DatabaseTasks.db_dir`.
942
+ *Danielius Visockas*
1031
943
 
1032
- *Eileen M. Uchitelle*, *Ryan Kerr*
944
+ * PostgreSQL adapter method `enable_extension` now allows parameter to be `[schema_name.]<extension_name>`
945
+ if the extension must be installed on another schema.
1033
946
 
1034
- * Add `ActiveRecord::Base.prohibit_shard_swapping` to prevent attempts to change the shard within a block.
947
+ Example: `enable_extension('heroku_ext.hstore')`
1035
948
 
1036
- *John Crepezzi*, *Eileen M. Uchitelle*
949
+ *Leonardo Luarte*
1037
950
 
1038
- * Filter unchanged attributes with default function from insert query when `partial_inserts` is disabled.
951
+ * Add `:include` option to `add_index`.
1039
952
 
1040
- *Akshay Birajdar*, *Jacopo Beschi*
953
+ Add support for including non-key columns in indexes for PostgreSQL
954
+ with the `INCLUDE` parameter.
1041
955
 
1042
- * Add support for FILTER clause (SQL:2003) to Arel.
956
+ ```ruby
957
+ add_index(:users, :email, include: [:id, :created_at])
958
+ ```
1043
959
 
1044
- Currently supported by PostgreSQL 9.4+ and SQLite 3.30+.
960
+ will result in:
1045
961
 
1046
- *Andrey Novikov*
962
+ ```sql
963
+ CREATE INDEX index_users_on_email USING btree (email) INCLUDE (id, created_at)
964
+ ```
1047
965
 
1048
- * Automatically set timestamps on record creation during bulk insert/upsert
966
+ *Steve Abrams*
1049
967
 
1050
- Prior to this change, only updates during an upsert operation (e.g. `upsert_all`) would touch timestamps (`updated_{at,on}`). Now, record creations also touch timestamp columns (`{created,updated}_{at,on}`).
968
+ * `ActiveRecord::Relation`’s `#any?`, `#none?`, and `#one?` methods take an optional pattern
969
+ argument, more closely matching their `Enumerable` equivalents.
1051
970
 
1052
- This behaviour is controlled by the `<model>.record_timestamps` config, matching the behaviour of `create`, `update`, etc. It can also be overridden by using the `record_timestamps:` keyword argument.
971
+ *George Claghorn*
1053
972
 
1054
- Note that this means `upsert_all` on models with `record_timestamps = false` will no longer touch `updated_{at,on}` automatically.
973
+ * Add `ActiveRecord::Base.normalizes` for declaring attribute normalizations.
1055
974
 
1056
- *Sam Bostock*
975
+ An attribute normalization is applied when the attribute is assigned or
976
+ updated, and the normalized value will be persisted to the database. The
977
+ normalization is also applied to the corresponding keyword argument of query
978
+ methods, allowing records to be queried using unnormalized values.
1057
979
 
1058
- * Don't require `role` when passing `shard` to `connected_to`.
980
+ For example:
1059
981
 
1060
- `connected_to` can now be called with a `shard` only. Note that `role` is still inherited if `connected_to` calls are nested.
982
+ ```ruby
983
+ class User < ActiveRecord::Base
984
+ normalizes :email, with: -> email { email.strip.downcase }
985
+ normalizes :phone, with: -> phone { phone.delete("^0-9").delete_prefix("1") }
986
+ end
1061
987
 
1062
- *Eileen M. Uchitelle*
988
+ user = User.create(email: " CRUISE-CONTROL@EXAMPLE.COM\n")
989
+ user.email # => "cruise-control@example.com"
1063
990
 
1064
- * Add option to lazily load the schema cache on the connection.
991
+ user = User.find_by(email: "\tCRUISE-CONTROL@EXAMPLE.COM ")
992
+ user.email # => "cruise-control@example.com"
993
+ user.email_before_type_cast # => "cruise-control@example.com"
1065
994
 
1066
- Previously, the only way to load the schema cache in Active Record was through the Railtie on boot. This option provides the ability to load the schema cache on the connection after it's been established. Loading the cache lazily on the connection can be beneficial for Rails applications that use multiple databases because it will load the cache at the time the connection is established. Currently Railties doesn't have access to the connections before boot.
995
+ User.where(email: "\tCRUISE-CONTROL@EXAMPLE.COM ").count # => 1
996
+ User.where(["email = ?", "\tCRUISE-CONTROL@EXAMPLE.COM "]).count # => 0
1067
997
 
1068
- To use the cache, set `config.active_record.lazily_load_schema_cache = true` in your application configuration. In addition a `schema_cache_path` should be set in your database configuration if you don't want to use the default "db/schema_cache.yml" path.
998
+ User.exists?(email: "\tCRUISE-CONTROL@EXAMPLE.COM ") # => true
999
+ User.exists?(["email = ?", "\tCRUISE-CONTROL@EXAMPLE.COM "]) # => false
1069
1000
 
1070
- *Eileen M. Uchitelle*
1001
+ User.normalize_value_for(:phone, "+1 (555) 867-5309") # => "5558675309"
1002
+ ```
1071
1003
 
1072
- * Allow automatic `inverse_of` detection for associations with scopes.
1004
+ *Jonathan Hefner*
1073
1005
 
1074
- Automatic `inverse_of` detection now works for associations with scopes. For
1075
- example, the `comments` association here now automatically detects
1076
- `inverse_of: :post`, so we don't need to pass that option:
1006
+ * Hide changes to before_committed! callback behaviour behind flag.
1077
1007
 
1078
- ```ruby
1079
- class Post < ActiveRecord::Base
1080
- has_many :comments, -> { visible }
1081
- end
1008
+ In #46525, behavior around before_committed! callbacks was changed so that callbacks
1009
+ would run on every enrolled record in a transaction, not just the first copy of a record.
1010
+ This change in behavior is now controlled by a configuration option,
1011
+ `config.active_record.before_committed_on_all_records`. It will be enabled by default on Rails 7.1.
1082
1012
 
1083
- class Comment < ActiveRecord::Base
1084
- belongs_to :post
1085
- end
1086
- ```
1013
+ *Adrianna Chang*
1087
1014
 
1088
- Note that the automatic detection still won't work if the inverse
1089
- association has a scope. In this example a scope on the `post` association
1090
- would still prevent Rails from finding the inverse for the `comments`
1091
- association.
1015
+ * The `namespaced_controller` Query Log tag now matches the `controller` format
1092
1016
 
1093
- This will be the default for new apps in Rails 7. To opt in:
1017
+ For example, a request processed by `NameSpaced::UsersController` will now log as:
1094
1018
 
1095
- ```ruby
1096
- config.active_record.automatic_scope_inversing = true
1019
+ ```
1020
+ :controller # "users"
1021
+ :namespaced_controller # "name_spaced/users"
1097
1022
  ```
1098
1023
 
1099
- *Daniel Colson*, *Chris Bloom*
1100
-
1101
- * Accept optional transaction args to `ActiveRecord::Locking::Pessimistic#with_lock`
1102
-
1103
- `#with_lock` now accepts transaction options like `requires_new:`,
1104
- `isolation:`, and `joinable:`
1105
-
1106
- *John Mileham*
1024
+ *Alex Ghiculescu*
1107
1025
 
1108
- * Adds support for deferrable foreign key constraints in PostgreSQL.
1026
+ * Return only unique ids from ActiveRecord::Calculations#ids
1109
1027
 
1110
- By default, foreign key constraints in PostgreSQL are checked after each statement. This works for most use cases,
1111
- but becomes a major limitation when creating related records before the parent record is inserted into the database.
1112
- One example of this is looking up / creating a person via one or more unique alias.
1028
+ Updated ActiveRecord::Calculations#ids to only return the unique ids of the base model
1029
+ when using eager_load, preload and includes.
1113
1030
 
1114
1031
  ```ruby
1115
- Person.transaction do
1116
- alias = Alias
1117
- .create_with(user_id: SecureRandom.uuid)
1118
- .create_or_find_by(name: "DHH")
1119
-
1120
- person = Person
1121
- .create_with(name: "David Heinemeier Hansson")
1122
- .create_or_find_by(id: alias.user_id)
1123
- end
1032
+ Post.find_by(id: 1).comments.count
1033
+ # => 5
1034
+ Post.includes(:comments).where(id: 1).pluck(:id)
1035
+ # => [1, 1, 1, 1, 1]
1036
+ Post.includes(:comments).where(id: 1).ids
1037
+ # => [1]
1124
1038
  ```
1125
1039
 
1126
- Using the default behavior, the transaction would fail when executing the first `INSERT` statement.
1127
-
1128
- By passing the `:deferrable` option to the `add_foreign_key` statement in migrations, it's possible to defer this
1129
- check.
1040
+ *Joshua Young*
1130
1041
 
1131
- ```ruby
1132
- add_foreign_key :aliases, :person, deferrable: true
1133
- ```
1042
+ * Stop using `LOWER()` for case-insensitive queries on `citext` columns
1134
1043
 
1135
- Passing `deferrable: true` doesn't change the default behavior, but allows manually deferring the check using
1136
- `SET CONSTRAINTS ALL DEFERRED` within a transaction. This will cause the foreign keys to be checked after the
1137
- transaction.
1044
+ Previously, `LOWER()` was added for e.g. uniqueness validations with
1045
+ `case_sensitive: false`.
1046
+ It wasn't mentioned in the documentation that the index without `LOWER()`
1047
+ wouldn't be used in this case.
1138
1048
 
1139
- It's also possible to adjust the default behavior from an immediate check (after the statement), to a deferred check
1140
- (after the transaction):
1049
+ *Phil Pirozhkov*
1141
1050
 
1142
- ```ruby
1143
- add_foreign_key :aliases, :person, deferrable: :deferred
1144
- ```
1051
+ * Extract `#sync_timezone_changes` method in AbstractMysqlAdapter to enable subclasses
1052
+ to sync database timezone changes without overriding `#raw_execute`.
1145
1053
 
1146
- *Benedikt Deicke*
1054
+ *Adrianna Chang*, *Paarth Madan*
1147
1055
 
1148
- * Allow configuring Postgres password through the socket URL.
1056
+ * Do not write additional new lines when dumping sql migration versions
1149
1057
 
1150
- For example:
1151
- ```ruby
1152
- ActiveRecord::DatabaseConfigurations::UrlConfig.new(
1153
- :production, :production, 'postgres:///?user=user&password=secret&dbname=app', {}
1154
- ).configuration_hash
1155
- ```
1058
+ This change updates the `insert_versions_sql` function so that the database insert string containing the current database migration versions does not end with two additional new lines.
1156
1059
 
1157
- will now return,
1060
+ *Misha Schwartz*
1158
1061
 
1159
- ```ruby
1160
- { :user=>"user", :password=>"secret", :dbname=>"app", :adapter=>"postgresql" }
1161
- ```
1062
+ * Fix `composed_of` value freezing and duplication.
1162
1063
 
1163
- *Abeid Ahmed*
1064
+ Previously composite values exhibited two confusing behaviors:
1164
1065
 
1165
- * PostgreSQL: support custom enum types
1066
+ - When reading a compositve value it'd _NOT_ be frozen, allowing it to get out of sync with its underlying database
1067
+ columns.
1068
+ - When writing a compositve value the argument would be frozen, potentially confusing the caller.
1166
1069
 
1167
- In migrations, use `create_enum` to add a new enum type, and `t.enum` to add a column.
1070
+ Currently, composite values instantiated based on database columns are frozen (addressing the first issue) and
1071
+ assigned compositve values are duplicated and the duplicate is frozen (addressing the second issue).
1168
1072
 
1169
- ```ruby
1170
- def up
1171
- create_enum :mood, ["happy", "sad"]
1073
+ *Greg Navis*
1172
1074
 
1173
- change_table :cats do |t|
1174
- t.enum :current_mood, enum_type: "mood", default: "happy", null: false
1175
- end
1176
- end
1177
- ```
1075
+ * Fix redundant updates to the column insensitivity cache
1178
1076
 
1179
- Enums will be presented correctly in `schema.rb`. Note that this is only supported by
1180
- the PostgreSQL adapter.
1077
+ Fixed redundant queries checking column capability for insensitive
1078
+ comparison.
1181
1079
 
1182
- *Alex Ghiculescu*
1080
+ *Phil Pirozhkov*
1183
1081
 
1184
- * Avoid COMMENT statements in PostgreSQL structure dumps
1082
+ * Allow disabling methods generated by `ActiveRecord.enum`.
1185
1083
 
1186
- COMMENT statements are now omitted from the output of `db:structure:dump` when using PostgreSQL >= 11.
1187
- This allows loading the dump without a pgsql superuser account.
1084
+ *Alfred Dominic*
1188
1085
 
1189
- Fixes #36816, #43107.
1086
+ * Avoid validating `belongs_to` association if it has not changed.
1190
1087
 
1191
- *Janosch Müller*
1088
+ Previously, when updating a record, Active Record will perform an extra query to check for the presence of
1089
+ `belongs_to` associations (if the presence is configured to be mandatory), even if that attribute hasn't changed.
1192
1090
 
1193
- * Add support for generated columns in PostgreSQL adapter
1091
+ Currently, only `belongs_to`-related columns are checked for presence. It is possible to have orphaned records with
1092
+ this approach. To avoid this problem, you need to use a foreign key.
1194
1093
 
1195
- Generated columns are supported since version 12.0 of PostgreSQL. This adds
1196
- support of those to the PostgreSQL adapter.
1094
+ This behavior can be controlled by configuration:
1197
1095
 
1198
1096
  ```ruby
1199
- create_table :users do |t|
1200
- t.string :name
1201
- t.virtual :name_upcased, type: :string, as: 'upper(name)', stored: true
1202
- end
1097
+ config.active_record.belongs_to_required_validates_foreign_key = false
1203
1098
  ```
1204
1099
 
1205
- *Michał Begejowicz*
1100
+ and will be disabled by default with `config.load_defaults 7.1`.
1206
1101
 
1102
+ *fatkodima*
1207
1103
 
1208
- ## Rails 7.0.0.alpha2 (September 15, 2021) ##
1104
+ * `has_one` and `belongs_to` associations now define a `reset_association` method
1105
+ on the owner model (where `association` is the name of the association). This
1106
+ method unloads the cached associate record, if any, and causes the next access
1107
+ to query it from the database.
1209
1108
 
1210
- * No changes.
1109
+ *George Claghorn*
1211
1110
 
1111
+ * Allow per attribute setting of YAML permitted classes (safe load) and unsafe load.
1212
1112
 
1213
- ## Rails 7.0.0.alpha1 (September 15, 2021) ##
1113
+ *Carlos Palhares*
1214
1114
 
1215
- * Remove warning when overwriting existing scopes
1115
+ * Add a build persistence method
1216
1116
 
1217
- Removes the following unnecessary warning message that appeared when overwriting existing scopes
1117
+ Provides a wrapper for `new`, to provide feature parity with `create`s
1118
+ ability to create multiple records from an array of hashes, using the
1119
+ same notation as the `build` method on associations.
1218
1120
 
1219
- ```
1220
- Creating scope :my_scope_name. Overwriting existing method "MyClass.my_scope_name" when overwriting existing scopes
1221
- ```
1121
+ *Sean Denny*
1222
1122
 
1223
- *Weston Ganger*
1123
+ * Raise on assignment to readonly attributes
1224
1124
 
1225
- * Use full precision for `updated_at` in `insert_all`/`upsert_all`
1125
+ ```ruby
1126
+ class Post < ActiveRecord::Base
1127
+ attr_readonly :content
1128
+ end
1129
+ Post.create!(content: "cannot be updated")
1130
+ post.content # "cannot be updated"
1131
+ post.content = "something else" # => ActiveRecord::ReadonlyAttributeError
1132
+ ```
1226
1133
 
1227
- `CURRENT_TIMESTAMP` provides differing precision depending on the database,
1228
- and not all databases support explicitly specifying additional precision.
1134
+ Previously, assignment would succeed but silently not write to the database.
1229
1135
 
1230
- Instead, we delegate to the new `connection.high_precision_current_timestamp`
1231
- for the SQL to produce a high precision timestamp on the current database.
1136
+ This behavior can be controlled by configuration:
1232
1137
 
1233
- Fixes #42992
1138
+ ```ruby
1139
+ config.active_record.raise_on_assign_to_attr_readonly = true
1140
+ ```
1234
1141
 
1235
- *Sam Bostock*
1142
+ and will be enabled by default with `config.load_defaults 7.1`.
1236
1143
 
1237
- * Add ssl support for postgresql database tasks
1144
+ *Alex Ghiculescu*, *Hartley McGuire*
1238
1145
 
1239
- Add `PGSSLMODE`, `PGSSLCERT`, `PGSSLKEY` and `PGSSLROOTCERT` to pg_env from database config
1240
- when running postgresql database tasks.
1146
+ * Allow unscoping of preload and eager_load associations
1241
1147
 
1242
- ```yaml
1243
- # config/database.yml
1148
+ Added the ability to unscope preload and eager_load associations just like
1149
+ includes, joins, etc. See ActiveRecord::QueryMethods::VALID_UNSCOPING_VALUES
1150
+ for the full list of supported unscopable scopes.
1244
1151
 
1245
- production:
1246
- sslmode: verify-full
1247
- sslcert: client.crt
1248
- sslkey: client.key
1249
- sslrootcert: ca.crt
1152
+ ```ruby
1153
+ query.unscope(:eager_load, :preload).group(:id).select(:id)
1250
1154
  ```
1251
1155
 
1252
- Environment variables
1156
+ *David Morehouse*
1253
1157
 
1254
- ```
1255
- PGSSLMODE=verify-full
1256
- PGSSLCERT=client.crt
1257
- PGSSLKEY=client.key
1258
- PGSSLROOTCERT=ca.crt
1259
- ```
1158
+ * Add automatic filtering of encrypted attributes on inspect
1260
1159
 
1261
- Fixes #42994
1160
+ This feature is enabled by default but can be disabled with
1262
1161
 
1263
- *Michael Bayucot*
1162
+ ```ruby
1163
+ config.active_record.encryption.add_to_filter_parameters = false
1164
+ ```
1165
+
1166
+ *Hartley McGuire*
1264
1167
 
1265
- * Avoid scoping update callbacks in `ActiveRecord::Relation#update!`.
1168
+ * Clear locking column on #dup
1266
1169
 
1267
- Making it consistent with how scoping is applied only to the query in `ActiveRecord::Relation#update`
1268
- and not also to the callbacks from the update itself.
1170
+ This change fixes not to duplicate locking_column like id and timestamps.
1269
1171
 
1270
- *Dylan Thacker-Smith*
1172
+ ```
1173
+ car = Car.create!
1174
+ car.touch
1175
+ car.lock_version #=> 1
1176
+ car.dup.lock_version #=> 0
1177
+ ```
1271
1178
 
1272
- * Fix 2 cases that inferred polymorphic class from the association's `foreign_type`
1273
- using `String#constantize` instead of the model's `polymorphic_class_for`.
1179
+ *Shouichi Kamiya*, *Seonggi Yang*, *Ryohei UEDA*
1274
1180
 
1275
- When updating a polymorphic association, the old `foreign_type` was not inferred correctly when:
1276
- 1. `touch`ing the previously associated record
1277
- 2. updating the previously associated record's `counter_cache`
1181
+ * Invalidate transaction as early as possible
1278
1182
 
1279
- *Jimmy Bourassa*
1183
+ After rescuing a `TransactionRollbackError` exception Rails invalidates transactions earlier in the flow
1184
+ allowing the framework to skip issuing the `ROLLBACK` statement in more cases.
1185
+ Only affects adapters that have `savepoint_errors_invalidate_transactions?` configured as `true`,
1186
+ which at this point is only applicable to the `mysql2` adapter.
1280
1187
 
1281
- * Add config option for ignoring tables when dumping the schema cache.
1188
+ *Nikita Vasilevsky*
1282
1189
 
1283
- Applications can now be configured to ignore certain tables when dumping the schema cache.
1190
+ * Allow configuring columns list to be used in SQL queries issued by an `ActiveRecord::Base` object
1284
1191
 
1285
- The configuration option can table an array of tables:
1192
+ It is now possible to configure columns list that will be used to build an SQL query clauses when
1193
+ updating, deleting or reloading an `ActiveRecord::Base` object
1286
1194
 
1287
1195
  ```ruby
1288
- config.active_record.schema_cache_ignored_tables = ["ignored_table", "another_ignored_table"]
1196
+ class Developer < ActiveRecord::Base
1197
+ query_constraints :company_id, :id
1198
+ end
1199
+ developer = Developer.first.update(name: "Bob")
1200
+ # => UPDATE "developers" SET "name" = 'Bob' WHERE "developers"."company_id" = 1 AND "developers"."id" = 1
1289
1201
  ```
1290
1202
 
1291
- Or a regex:
1203
+ *Nikita Vasilevsky*
1292
1204
 
1293
- ```ruby
1294
- config.active_record.schema_cache_ignored_tables = [/^_/]
1295
- ```
1205
+ * Adds `validate` to foreign keys and check constraints in schema.rb
1296
1206
 
1297
- *Eileen M. Uchitelle*
1207
+ Previously, `schema.rb` would not record if `validate: false` had been used when adding a foreign key or check
1208
+ constraint, so restoring a database from the schema could result in foreign keys or check constraints being
1209
+ incorrectly validated.
1298
1210
 
1299
- * Make schema cache methods return consistent results.
1211
+ *Tommy Graves*
1300
1212
 
1301
- Previously the schema cache methods `primary_keys`, `columns`, `columns_hash`, and `indexes`
1302
- would behave differently than one another when a table didn't exist and differently across
1303
- database adapters. This change unifies the behavior so each method behaves the same regardless
1304
- of adapter.
1213
+ * Adapter `#execute` methods now accept an `allow_retry` option. When set to `true`, the SQL statement will be
1214
+ retried, up to the database's configured `connection_retries` value, upon encountering connection-related errors.
1305
1215
 
1306
- The behavior now is:
1216
+ *Adrianna Chang*
1307
1217
 
1308
- `columns`: (unchanged) raises a db error if the table does not exist.
1309
- `columns_hash`: (unchanged) raises a db error if the table does not exist.
1310
- `primary_keys`: (unchanged) returns `nil` if the table does not exist.
1311
- `indexes`: (changed for mysql2) returns `[]` if the table does not exist.
1218
+ * Only trigger `after_commit :destroy` callbacks when a database row is deleted.
1312
1219
 
1313
- *Eileen M. Uchitelle*
1220
+ This prevents `after_commit :destroy` callbacks from being triggered again
1221
+ when `destroy` is called multiple times on the same record.
1314
1222
 
1315
- * Reestablish connection to previous database after after running `db:schema:load:name`
1223
+ *Ben Sheldon*
1316
1224
 
1317
- After running `db:schema:load:name` the previous connection is restored.
1225
+ * Fix `ciphertext_for` for yet-to-be-encrypted values.
1318
1226
 
1319
- *Jacopo Beschi*
1227
+ Previously, `ciphertext_for` returned the cleartext of values that had not
1228
+ yet been encrypted, such as with an unpersisted record:
1320
1229
 
1321
- * Add database config option `database_tasks`
1230
+ ```ruby
1231
+ Post.encrypts :body
1322
1232
 
1323
- If you would like to connect to an external database without any database
1324
- management tasks such as schema management, migrations, seeds, etc. you can set
1325
- the per database config option `database_tasks: false`
1233
+ post = Post.create!(body: "Hello")
1234
+ post.ciphertext_for(:body)
1235
+ # => "{\"p\":\"abc..."
1326
1236
 
1327
- ```yaml
1328
- # config/database.yml
1237
+ post.body = "World"
1238
+ post.ciphertext_for(:body)
1239
+ # => "World"
1240
+ ```
1329
1241
 
1330
- production:
1331
- primary:
1332
- database: my_database
1333
- adapter: mysql2
1334
- animals:
1335
- database: my_animals_database
1336
- adapter: mysql2
1337
- database_tasks: false
1338
- ```
1242
+ Now, `ciphertext_for` will always return the ciphertext of encrypted
1243
+ attributes:
1339
1244
 
1340
- *Weston Ganger*
1245
+ ```ruby
1246
+ Post.encrypts :body
1341
1247
 
1342
- * Fix `ActiveRecord::InternalMetadata` to not be broken by `config.active_record.record_timestamps = false`
1248
+ post = Post.create!(body: "Hello")
1249
+ post.ciphertext_for(:body)
1250
+ # => "{\"p\":\"abc..."
1343
1251
 
1344
- Since the model always create the timestamp columns, it has to set them, otherwise it breaks
1345
- various DB management tasks.
1252
+ post.body = "World"
1253
+ post.ciphertext_for(:body)
1254
+ # => "{\"p\":\"xyz..."
1255
+ ```
1346
1256
 
1347
- Fixes #42983
1257
+ *Jonathan Hefner*
1348
1258
 
1349
- * Add `ActiveRecord::QueryLogs`.
1259
+ * Fix a bug where using groups and counts with long table names would return incorrect results.
1350
1260
 
1351
- Configurable tags can be automatically added to all SQL queries generated by Active Record.
1261
+ *Shota Toguchi*, *Yusaku Ono*
1352
1262
 
1353
- ```ruby
1354
- # config/application.rb
1355
- module MyApp
1356
- class Application < Rails::Application
1357
- config.active_record.query_log_tags_enabled = true
1358
- end
1359
- end
1360
- ```
1263
+ * Fix encryption of column default values.
1361
1264
 
1362
- By default the application, controller and action details are added to the query tags:
1265
+ Previously, encrypted attributes that used column default values appeared to
1266
+ be encrypted on create, but were not:
1363
1267
 
1364
- ```ruby
1365
- class BooksController < ApplicationController
1366
- def index
1367
- @books = Book.all
1368
- end
1369
- end
1370
- ```
1268
+ ```ruby
1269
+ Book.encrypts :name
1371
1270
 
1372
- ```ruby
1373
- GET /books
1374
- # SELECT * FROM books /*application:MyApp;controller:books;action:index*/
1375
- ```
1271
+ book = Book.create!
1272
+ book.name
1273
+ # => "<untitled>"
1274
+ book.name_before_type_cast
1275
+ # => "{\"p\":\"abc..."
1276
+ book.reload.name_before_type_cast
1277
+ # => "<untitled>"
1278
+ ```
1376
1279
 
1377
- Custom tags containing static values and Procs can be defined in the application configuration:
1280
+ Now, attributes with column default values are encrypted:
1378
1281
 
1379
- ```ruby
1380
- config.active_record.query_log_tags = [
1381
- :application,
1382
- :controller,
1383
- :action,
1384
- {
1385
- custom_static: "foo",
1386
- custom_dynamic: -> { Time.now }
1387
- }
1388
- ]
1389
- ```
1282
+ ```ruby
1283
+ Book.encrypts :name
1390
1284
 
1391
- *Keeran Raj Hawoldar*, *Eileen M. Uchitelle*, *Kasper Timm Hansen*
1285
+ book = Book.create!
1286
+ book.name
1287
+ # => "<untitled>"
1288
+ book.name_before_type_cast
1289
+ # => "{\"p\":\"abc..."
1290
+ book.reload.name_before_type_cast
1291
+ # => "{\"p\":\"abc..."
1292
+ ```
1392
1293
 
1393
- * Added support for multiple databases to `rails db:setup` and `rails db:reset`.
1294
+ *Jonathan Hefner*
1394
1295
 
1395
- *Ryan Hall*
1296
+ * Deprecate delegation from `Base` to `connection_handler`.
1396
1297
 
1397
- * Add `ActiveRecord::Relation#structurally_compatible?`.
1298
+ Calling `Base.clear_all_connections!`, `Base.clear_active_connections!`, `Base.clear_reloadable_connections!` and `Base.flush_idle_connections!` is deprecated. Please call these methods on the connection handler directly. In future Rails versions, the delegation from `Base` to the `connection_handler` will be removed.
1398
1299
 
1399
- Adds a query method by which a user can tell if the relation that they're
1400
- about to use for `#or` or `#and` is structurally compatible with the
1401
- receiver.
1300
+ *Eileen M. Uchitelle*
1402
1301
 
1403
- *Kevin Newton*
1302
+ * Allow ActiveRecord::QueryMethods#reselect to receive hash values, similar to ActiveRecord::QueryMethods#select
1404
1303
 
1405
- * Add `ActiveRecord::QueryMethods#in_order_of`.
1304
+ *Sampat Badhe*
1406
1305
 
1407
- This allows you to specify an explicit order that you'd like records
1408
- returned in based on a SQL expression. By default, this will be accomplished
1409
- using a case statement, as in:
1306
+ * Validate options when managing columns and tables in migrations.
1410
1307
 
1411
- ```ruby
1412
- Post.in_order_of(:id, [3, 5, 1])
1413
- ```
1308
+ If an invalid option is passed to a migration method like `create_table` and `add_column`, an error will be raised
1309
+ instead of the option being silently ignored. Validation of the options will only be applied for new migrations
1310
+ that are created.
1414
1311
 
1415
- will generate the SQL:
1312
+ *Guo Xiang Tan*, *George Wambold*
1416
1313
 
1417
- ```sql
1418
- SELECT "posts".* FROM "posts" ORDER BY CASE "posts"."id" WHEN 3 THEN 1 WHEN 5 THEN 2 WHEN 1 THEN 3 ELSE 4 END ASC
1419
- ```
1314
+ * Update query log tags to use the [SQLCommenter](https://open-telemetry.github.io/opentelemetry-sqlcommenter/) format by default. See [#46179](https://github.com/rails/rails/issues/46179)
1420
1315
 
1421
- However, because this functionality is built into MySQL in the form of the
1422
- `FIELD` function, that connection adapter will generate the following SQL
1423
- instead:
1316
+ To opt out of SQLCommenter-formatted query log tags, set `config.active_record.query_log_tags_format = :legacy`. By default, this is set to `:sqlcommenter`.
1424
1317
 
1425
- ```sql
1426
- SELECT "posts".* FROM "posts" ORDER BY FIELD("posts"."id", 1, 5, 3) DESC
1427
- ```
1318
+ *Modulitos* and *Iheanyi*
1428
1319
 
1429
- *Kevin Newton*
1320
+ * Allow any ERB in the database.yml when creating rake tasks.
1430
1321
 
1431
- * Fix `eager_loading?` when ordering with `Symbol`.
1322
+ Any ERB can be used in `database.yml` even if it accesses environment
1323
+ configurations.
1432
1324
 
1433
- `eager_loading?` is triggered correctly when using `order` with symbols.
1325
+ Deprecates `config.active_record.suppress_multiple_database_warning`.
1434
1326
 
1435
- ```ruby
1436
- scope = Post.includes(:comments).order(:"comments.label")
1437
- => true
1438
- ```
1327
+ *Eike Send*
1439
1328
 
1440
- *Jacopo Beschi*
1329
+ * Add table to error for duplicate column definitions.
1441
1330
 
1442
- * Two change tracking methods are added for `belongs_to` associations.
1331
+ If a migration defines duplicate columns for a table, the error message
1332
+ shows which table it concerns.
1443
1333
 
1444
- The `association_changed?` method (assuming an association named `:association`) returns true
1445
- if a different associated object has been assigned and the foreign key will be updated in the
1446
- next save.
1334
+ *Petrik de Heus*
1447
1335
 
1448
- The `association_previously_changed?` method returns true if the previous save updated the
1449
- association to reference a different associated object.
1336
+ * Fix erroneous nil default precision on virtual datetime columns.
1450
1337
 
1451
- *George Claghorn*
1338
+ Prior to this change, virtual datetime columns did not have the same
1339
+ default precision as regular datetime columns, resulting in the following
1340
+ being erroneously equivalent:
1452
1341
 
1453
- * Add option to disable schema dump per-database.
1342
+ t.virtual :name, type: datetime, as: "expression"
1343
+ t.virtual :name, type: datetime, precision: nil, as: "expression"
1454
1344
 
1455
- Dumping the schema is on by default for all databases in an application. To turn it off for a
1456
- specific database, use the `schema_dump` option:
1345
+ This change fixes the default precision lookup, so virtual and regular
1346
+ datetime column default precisions match.
1457
1347
 
1458
- ```yaml
1459
- # config/database.yml
1348
+ *Sam Bostock*
1460
1349
 
1461
- production:
1462
- schema_dump: false
1463
- ```
1350
+ * Use connection from `#with_raw_connection` in `#quote_string`.
1464
1351
 
1465
- *Luis Vasconcellos*, *Eileen M. Uchitelle*
1352
+ This ensures that the string quoting is wrapped in the reconnect and retry logic
1353
+ that `#with_raw_connection` offers.
1466
1354
 
1467
- * Fix `eager_loading?` when ordering with `Hash` syntax.
1355
+ *Adrianna Chang*
1468
1356
 
1469
- `eager_loading?` is triggered correctly when using `order` with hash syntax
1470
- on an outer table.
1357
+ * Add `expires_in` option to `signed_id`.
1471
1358
 
1472
- ```ruby
1473
- Post.includes(:comments).order({ "comments.label": :ASC }).eager_loading?
1474
- # => true
1475
- ```
1359
+ *Shouichi Kamiya*
1476
1360
 
1477
- *Jacopo Beschi*
1361
+ * Allow applications to set retry deadline for query retries.
1478
1362
 
1479
- * Move the forcing of clear text encoding to the `ActiveRecord::Encryption::Encryptor`.
1363
+ Building on the work done in #44576 and #44591, we extend the logic that automatically
1364
+ reconnects database connections to take into account a timeout limit. We won't retry
1365
+ a query if a given amount of time has elapsed since the query was first attempted. This
1366
+ value defaults to nil, meaning that all retryable queries are retried regardless of time elapsed,
1367
+ but this can be changed via the `retry_deadline` option in the database config.
1480
1368
 
1481
- Fixes #42699.
1369
+ *Adrianna Chang*
1482
1370
 
1483
- *J Smith*
1371
+ * Fix a case where the query cache can return wrong values. See #46044
1484
1372
 
1485
- * `partial_inserts` is now disabled by default in new apps.
1373
+ *Aaron Patterson*
1486
1374
 
1487
- This will be the default for new apps in Rails 7. To opt in:
1375
+ * Support MySQL's ssl-mode option for MySQLDatabaseTasks.
1488
1376
 
1489
- ```ruby
1490
- config.active_record.partial_inserts = true
1491
- ```
1377
+ Verifying the identity of the database server requires setting the ssl-mode
1378
+ option to VERIFY_CA or VERIFY_IDENTITY. This option was previously ignored
1379
+ for MySQL database tasks like creating a database and dumping the structure.
1492
1380
 
1493
- If a migration removes the default value of a column, this option
1494
- would cause old processes to no longer be able to create new records.
1381
+ *Petrik de Heus*
1495
1382
 
1496
- If you need to remove a column, you should first use `ignored_columns`
1497
- to stop using it.
1383
+ * Move `ActiveRecord::InternalMetadata` to an independent object.
1498
1384
 
1499
- *Jean Boussier*
1385
+ `ActiveRecord::InternalMetadata` no longer inherits from `ActiveRecord::Base` and is now an independent object that should be instantiated with a `connection`. This class is private and should not be used by applications directly. If you want to interact with the schema migrations table, please access it on the connection directly, for example: `ActiveRecord::Base.connection.schema_migration`.
1500
1386
 
1501
- * Rails can now verify foreign keys after loading fixtures in tests.
1387
+ *Eileen M. Uchitelle*
1502
1388
 
1503
- This will be the default for new apps in Rails 7. To opt in:
1389
+ * Deprecate quoting `ActiveSupport::Duration` as an integer
1504
1390
 
1505
- ```ruby
1506
- config.active_record.verify_foreign_keys_for_fixtures = true
1391
+ Using ActiveSupport::Duration as an interpolated bind parameter in a SQL
1392
+ string template is deprecated. To avoid this warning, you should explicitly
1393
+ convert the duration to a more specific database type. For example, if you
1394
+ want to use a duration as an integer number of seconds:
1395
+ ```
1396
+ Record.where("duration = ?", 1.hour.to_i)
1397
+ ```
1398
+ If you want to use a duration as an ISO 8601 string:
1399
+ ```
1400
+ Record.where("duration = ?", 1.hour.iso8601)
1507
1401
  ```
1508
1402
 
1509
- Tests will not run if there is a foreign key constraint violation in your fixture data.
1510
-
1511
- The feature is supported by SQLite and PostgreSQL, other adapters can also add support for it.
1403
+ *Aram Greenman*
1512
1404
 
1513
- *Alex Ghiculescu*
1405
+ * Allow `QueryMethods#in_order_of` to order by a string column name.
1514
1406
 
1515
- * Clear cached `has_one` association after setting `belongs_to` association to `nil`.
1407
+ ```ruby
1408
+ Post.in_order_of("id", [4,2,3,1]).to_a
1409
+ Post.joins(:author).in_order_of("authors.name", ["Bob", "Anna", "John"]).to_a
1410
+ ```
1516
1411
 
1517
- After setting a `belongs_to` relation to `nil` and updating an unrelated attribute on the owner,
1518
- the owner should still return `nil` on the `has_one` relation.
1412
+ *Igor Kasyanchuk*
1519
1413
 
1520
- Fixes #42597.
1414
+ * Move `ActiveRecord::SchemaMigration` to an independent object.
1521
1415
 
1522
- *Michiel de Mare*
1416
+ `ActiveRecord::SchemaMigration` no longer inherits from `ActiveRecord::Base` and is now an independent object that should be instantiated with a `connection`. This class is private and should not be used by applications directly. If you want to interact with the schema migrations table, please access it on the connection directly, for example: `ActiveRecord::Base.connection.schema_migration`.
1523
1417
 
1524
- * OpenSSL constants are now used for Digest computations.
1418
+ *Eileen M. Uchitelle*
1525
1419
 
1526
- *Dirkjan Bussink*
1420
+ * Deprecate `all_connection_pools` and make `connection_pool_list` more explicit.
1527
1421
 
1528
- * Adds support for `if_not_exists` to `add_foreign_key` and `if_exists` to `remove_foreign_key`.
1422
+ Following on #45924 `all_connection_pools` is now deprecated. `connection_pool_list` will either take an explicit role or applications can opt into the new behavior by passing `:all`.
1529
1423
 
1530
- Applications can set their migrations to ignore exceptions raised when adding a foreign key
1531
- that already exists or when removing a foreign key that does not exist.
1424
+ *Eileen M. Uchitelle*
1532
1425
 
1533
- Example Usage:
1426
+ * Fix connection handler methods to operate on all pools.
1534
1427
 
1535
- ```ruby
1536
- class AddAuthorsForeignKeyToArticles < ActiveRecord::Migration[7.0]
1537
- def change
1538
- add_foreign_key :articles, :authors, if_not_exists: true
1539
- end
1540
- end
1541
- ```
1428
+ `active_connections?`, `clear_active_connections!`, `clear_reloadable_connections!`, `clear_all_connections!`, and `flush_idle_connections!` now operate on all pools by default. Previously they would default to using the `current_role` or `:writing` role unless specified.
1542
1429
 
1543
- ```ruby
1544
- class RemoveAuthorsForeignKeyFromArticles < ActiveRecord::Migration[7.0]
1545
- def change
1546
- remove_foreign_key :articles, :authors, if_exists: true
1547
- end
1548
- end
1549
- ```
1430
+ *Eileen M. Uchitelle*
1550
1431
 
1551
- *Roberto Miranda*
1552
1432
 
1553
- * Prevent polluting ENV during postgresql structure dump/load.
1433
+ * Allow ActiveRecord::QueryMethods#select to receive hash values.
1554
1434
 
1555
- Some configuration parameters were provided to pg_dump / psql via
1556
- environment variables which persisted beyond the command being run, and may
1557
- have caused subsequent commands and connections to fail. Tasks running
1558
- across multiple postgresql databases like `rails db:test:prepare` may have
1559
- been affected.
1435
+ Currently, `select` might receive only raw sql and symbols to define columns and aliases to select.
1560
1436
 
1561
- *Samuel Cochran*
1437
+ With this change we can provide `hash` as argument, for example:
1562
1438
 
1563
- * Set precision 6 by default for `datetime` columns.
1439
+ ```ruby
1440
+ Post.joins(:comments).select(posts: [:id, :title, :created_at], comments: [:id, :body, :author_id])
1441
+ #=> "SELECT \"posts\".\"id\", \"posts\".\"title\", \"posts\".\"created_at\", \"comments\".\"id\", \"comments\".\"body\", \"comments\".\"author_id\"
1442
+ # FROM \"posts\" INNER JOIN \"comments\" ON \"comments\".\"post_id\" = \"posts\".\"id\""
1564
1443
 
1565
- By default, datetime columns will have microseconds precision instead of seconds precision.
1444
+ Post.joins(:comments).select(posts: { id: :post_id, title: :post_title }, comments: { id: :comment_id, body: :comment_body })
1445
+ #=> "SELECT posts.id as post_id, posts.title as post_title, comments.id as comment_id, comments.body as comment_body
1446
+ # FROM \"posts\" INNER JOIN \"comments\" ON \"comments\".\"post_id\" = \"posts\".\"id\""
1447
+ ```
1448
+ *Oleksandr Holubenko*, *Josef Šimánek*, *Jean Boussier*
1566
1449
 
1567
- *Roberto Miranda*
1450
+ * Adapts virtual attributes on `ActiveRecord::Persistence#becomes`.
1568
1451
 
1569
- * Allow preloading of associations with instance dependent scopes.
1452
+ When source and target classes have a different set of attributes adapts
1453
+ attributes such that the extra attributes from target are added.
1570
1454
 
1571
- *John Hawthorn*, *John Crepezzi*, *Adam Hess*, *Eileen M. Uchitelle*, *Dinah Shi*
1455
+ ```ruby
1456
+ class Person < ApplicationRecord
1457
+ end
1572
1458
 
1573
- * Do not try to rollback transactions that failed due to a `ActiveRecord::TransactionRollbackError`.
1459
+ class WebUser < Person
1460
+ attribute :is_admin, :boolean
1461
+ after_initialize :set_admin
1574
1462
 
1575
- *Jamie McCarthy*
1463
+ def set_admin
1464
+ write_attribute(:is_admin, email =~ /@ourcompany\.com$/)
1465
+ end
1466
+ end
1576
1467
 
1577
- * Active Record Encryption will now encode values as UTF-8 when using deterministic
1578
- encryption. The encoding is part of the encrypted payload, so different encodings for
1579
- different values result in different ciphertexts. This can break unique constraints and
1580
- queries.
1468
+ person = Person.find_by(email: "email@ourcompany.com")
1469
+ person.respond_to? :is_admin
1470
+ # => false
1471
+ person.becomes(WebUser).is_admin?
1472
+ # => true
1473
+ ```
1581
1474
 
1582
- The new behavior is configurable via `active_record.encryption.forced_encoding_for_deterministic_encryption`
1583
- that is `Encoding::UTF_8` by default. It can be disabled by setting it to `nil`.
1475
+ *Jacopo Beschi*, *Sampson Crowley*
1584
1476
 
1585
- *Jorge Manrubia*
1477
+ * Fix `ActiveRecord::QueryMethods#in_order_of` to include `nil`s, to match the
1478
+ behavior of `Enumerable#in_order_of`.
1586
1479
 
1587
- * The MySQL adapter now cast numbers and booleans bind parameters to string for safety reasons.
1480
+ For example, `Post.in_order_of(:title, [nil, "foo"])` will now include posts
1481
+ with `nil` titles, the same as `Post.all.to_a.in_order_of(:title, [nil, "foo"])`.
1588
1482
 
1589
- When comparing a string and a number in a query, MySQL converts the string to a number. So for
1590
- instance `"foo" = 0`, will implicitly cast `"foo"` to `0` and will evaluate to `TRUE` which can
1591
- lead to security vulnerabilities.
1483
+ *fatkodima*
1592
1484
 
1593
- Active Record already protect against that vulnerability when it knows the type of the column
1594
- being compared, however until now it was still vulnerable when using bind parameters:
1485
+ * Optimize `add_timestamps` to use a single SQL statement.
1595
1486
 
1596
1487
  ```ruby
1597
- User.where("login_token = ?", 0).first
1488
+ add_timestamps :my_table
1598
1489
  ```
1599
1490
 
1600
- Would perform:
1491
+ Now results in the following SQL:
1601
1492
 
1602
1493
  ```sql
1603
- SELECT * FROM `users` WHERE `login_token` = 0 LIMIT 1;
1494
+ ALTER TABLE "my_table" ADD COLUMN "created_at" datetime(6) NOT NULL, ADD COLUMN "updated_at" datetime(6) NOT NULL
1604
1495
  ```
1605
1496
 
1606
- Now it will perform:
1607
-
1608
- ```sql
1609
- SELECT * FROM `users` WHERE `login_token` = '0' LIMIT 1;
1610
- ```
1497
+ *Iliana Hadzhiatanasova*
1611
1498
 
1612
- *Jean Boussier*
1499
+ * Add `drop_enum` migration command for PostgreSQL
1613
1500
 
1614
- * Fixture configurations (`_fixture`) are now strictly validated.
1501
+ This does the inverse of `create_enum`. Before dropping an enum, ensure you have
1502
+ dropped columns that depend on it.
1615
1503
 
1616
- If an error will be raised if that entry contains unknown keys while previously it
1617
- would silently have no effects.
1504
+ *Alex Ghiculescu*
1618
1505
 
1619
- *Jean Boussier*
1506
+ * Adds support for `if_exists` option when removing a check constraint.
1620
1507
 
1621
- * Add `ActiveRecord::Base.update!` that works like `ActiveRecord::Base.update` but raises exceptions.
1508
+ The `remove_check_constraint` method now accepts an `if_exists` option. If set
1509
+ to true an error won't be raised if the check constraint doesn't exist.
1622
1510
 
1623
- This allows for the same behavior as the instance method `#update!` at a class level.
1511
+ *Margaret Parsa* and *Aditya Bhutani*
1624
1512
 
1625
- ```ruby
1626
- Person.update!(:all, state: "confirmed")
1627
- ```
1513
+ * `find_or_create_by` now try to find a second time if it hits a unicity constraint.
1628
1514
 
1629
- *Dorian Marié*
1515
+ `find_or_create_by` always has been inherently racy, either creating multiple
1516
+ duplicate records or failing with `ActiveRecord::RecordNotUnique` depending on
1517
+ whether a proper unicity constraint was set.
1630
1518
 
1631
- * Add `ActiveRecord::Base#attributes_for_database`.
1519
+ `create_or_find_by` was introduced for this use case, however it's quite wasteful
1520
+ when the record is expected to exist most of the time, as INSERT require to send
1521
+ more data than SELECT and require more work from the database. Also on some
1522
+ databases it can actually consume a primary key increment which is undesirable.
1632
1523
 
1633
- Returns attributes with values for assignment to the database.
1524
+ So for case where most of the time the record is expected to exist, `find_or_create_by`
1525
+ can be made race-condition free by re-trying the `find` if the `create` failed
1526
+ with `ActiveRecord::RecordNotUnique`. This assumes that the table has the proper
1527
+ unicity constraints, if not, `find_or_create_by` will still lead to duplicated records.
1634
1528
 
1635
- *Chris Salzberg*
1529
+ *Jean Boussier*, *Alex Kitchens*
1636
1530
 
1637
- * Use an empty query to check if the PostgreSQL connection is still active.
1531
+ * Introduce a simpler constructor API for ActiveRecord database adapters.
1638
1532
 
1639
- An empty query is faster than `SELECT 1`.
1533
+ Previously the adapter had to know how to build a new raw connection to
1534
+ support reconnect, but also expected to be passed an initial already-
1535
+ established connection.
1640
1536
 
1641
- *Heinrich Lee Yu*
1537
+ When manually creating an adapter instance, it will now accept a single
1538
+ config hash, and only establish the real connection on demand.
1642
1539
 
1643
- * Add `ActiveRecord::Base#previously_persisted?`.
1540
+ *Matthew Draper*
1644
1541
 
1645
- Returns `true` if the object has been previously persisted but now it has been deleted.
1542
+ * Avoid redundant `SELECT 1` connection-validation query during DB pool
1543
+ checkout when possible.
1646
1544
 
1647
- * Deprecate `partial_writes` in favor of `partial_inserts` and `partial_updates`.
1545
+ If the first query run during a request is known to be idempotent, it can be
1546
+ used directly to validate the connection, saving a network round-trip.
1648
1547
 
1649
- This allows to have a different behavior on update and create.
1548
+ *Matthew Draper*
1650
1549
 
1651
- *Jean Boussier*
1550
+ * Automatically reconnect broken database connections when safe, even
1551
+ mid-request.
1652
1552
 
1653
- * Fix compatibility with `psych >= 4`.
1553
+ When an error occurs while attempting to run a known-idempotent query, and
1554
+ not inside a transaction, it is safe to immediately reconnect to the
1555
+ database server and try again, so this is now the default behavior.
1654
1556
 
1655
- Starting in Psych 4.0.0 `YAML.load` behaves like `YAML.safe_load`. To preserve compatibility,
1656
- Active Record's schema cache loader and `YAMLColumn` now uses `YAML.unsafe_load` if available.
1557
+ This new default should always be safe -- to support that, it's consciously
1558
+ conservative about which queries are considered idempotent -- but if
1559
+ necessary it can be disabled by setting the `connection_retries` connection
1560
+ option to `0`.
1657
1561
 
1658
- *Jean Boussier*
1562
+ *Matthew Draper*
1659
1563
 
1660
- * `ActiveRecord::Base.logger` is now a `class_attribute`.
1564
+ * Avoid removing a PostgreSQL extension when there are dependent objects.
1661
1565
 
1662
- This means it can no longer be accessed directly through `@@logger`, and that setting `logger =`
1663
- on a subclass won't change the parent's logger.
1566
+ Previously, removing an extension also implicitly removed dependent objects. Now, this will raise an error.
1664
1567
 
1665
- *Jean Boussier*
1568
+ You can force removing the extension:
1666
1569
 
1667
- * Add `.asc.nulls_first` for all databases. Unfortunately MySQL still doesn't like `nulls_last`.
1570
+ ```ruby
1571
+ disable_extension :citext, force: :cascade
1572
+ ```
1668
1573
 
1669
- *Keenan Brock*
1574
+ Fixes #29091.
1670
1575
 
1671
- * Improve performance of `one?` and `many?` by limiting the generated count query to 2 results.
1576
+ *fatkodima*
1672
1577
 
1673
- *Gonzalo Riestra*
1578
+ * Allow nested functions as safe SQL string
1674
1579
 
1675
- * Don't check type when using `if_not_exists` on `add_column`.
1580
+ *Michael Siegfried*
1676
1581
 
1677
- Previously, if a migration called `add_column` with the `if_not_exists` option set to true
1678
- the `column_exists?` check would look for a column with the same name and type as the migration.
1582
+ * Allow `destroy_association_async_job=` to be configured with a class string instead of a constant.
1679
1583
 
1680
- Recently it was discovered that the type passed to the migration is not always the same type
1681
- as the column after migration. For example a column set to `:mediumblob` in the migration will
1682
- be casted to `binary` when calling `column.type`. Since there is no straightforward way to cast
1683
- the type to the database type without running the migration, we opted to drop the type check from
1684
- `add_column`. This means that migrations adding a duplicate column with a different type will no
1685
- longer raise an error.
1584
+ Defers an autoloading dependency between `ActiveRecord::Base` and `ActiveJob::Base`
1585
+ and moves the configuration of `ActiveRecord::DestroyAssociationAsyncJob`
1586
+ from ActiveJob to ActiveRecord.
1686
1587
 
1687
- *Eileen M. Uchitelle*
1588
+ Deprecates `ActiveRecord::ActiveJobRequiredError` and now raises a `NameError`
1589
+ if the job class is unloadable or an `ActiveRecord::ConfigurationError` if
1590
+ `dependent: :destroy_async` is declared on an association but there is no job
1591
+ class configured.
1688
1592
 
1689
- * Log a warning message when running SQLite in production.
1593
+ *Ben Sheldon*
1690
1594
 
1691
- Using SQLite in production ENV is generally discouraged. SQLite is also the default adapter
1692
- in a new Rails application.
1693
- For the above reasons log a warning message when running SQLite in production.
1595
+ * Fix `ActiveRecord::Store` to serialize as a regular Hash
1694
1596
 
1695
- The warning can be disabled by setting `config.active_record.sqlite3_production_warning=false`.
1597
+ Previously it would serialize as an `ActiveSupport::HashWithIndifferentAccess`
1598
+ which is wasteful and cause problem with YAML safe_load.
1696
1599
 
1697
- *Jacopo Beschi*
1600
+ *Jean Boussier*
1698
1601
 
1699
- * Add option to disable joins for `has_one` associations.
1602
+ * Add `timestamptz` as a time zone aware type for PostgreSQL
1700
1603
 
1701
- In a multiple database application, associations can't join across
1702
- databases. When set, this option instructs Rails to generate 2 or
1703
- more queries rather than generating joins for `has_one` associations.
1604
+ This is required for correctly parsing `timestamp with time zone` values in your database.
1704
1605
 
1705
- Set the option on a has one through association:
1606
+ If you don't want this, you can opt out by adding this initializer:
1706
1607
 
1707
1608
  ```ruby
1708
- class Person
1709
- has_one :dog
1710
- has_one :veterinarian, through: :dog, disable_joins: true
1711
- end
1712
- ```
1713
-
1714
- Then instead of generating join SQL, two queries are used for `@person.veterinarian`:
1715
-
1716
- ```
1717
- SELECT "dogs"."id" FROM "dogs" WHERE "dogs"."person_id" = ? [["person_id", 1]]
1718
- SELECT "veterinarians".* FROM "veterinarians" WHERE "veterinarians"."dog_id" = ? [["dog_id", 1]]
1609
+ ActiveRecord::Base.time_zone_aware_types -= [:timestamptz]
1719
1610
  ```
1720
1611
 
1721
- *Sarah Vessels*, *Eileen M. Uchitelle*
1722
-
1723
- * `Arel::Visitors::Dot` now renders a complete set of properties when visiting
1724
- `Arel::Nodes::SelectCore`, `SelectStatement`, `InsertStatement`, `UpdateStatement`, and
1725
- `DeleteStatement`, which fixes #42026. Previously, some properties were omitted.
1726
-
1727
- *Mike Dalessio*
1612
+ *Alex Ghiculescu*
1728
1613
 
1729
- * `Arel::Visitors::Dot` now supports `Arel::Nodes::Bin`, `Case`, `CurrentRow`, `Distinct`,
1730
- `DistinctOn`, `Else`, `Except`, `InfixOperation`, `Intersect`, `Lock`, `NotRegexp`, `Quoted`,
1731
- `Regexp`, `UnaryOperation`, `Union`, `UnionAll`, `When`, and `With`. Previously, these node
1732
- types caused an exception to be raised by `Arel::Visitors::Dot#accept`.
1614
+ * Add new `ActiveRecord::Base.generates_token_for` API.
1733
1615
 
1734
- *Mike Dalessio*
1616
+ Currently, `signed_id` fulfills the role of generating tokens for e.g.
1617
+ resetting a password. However, signed IDs cannot reflect record state, so
1618
+ if a token is intended to be single-use, it must be tracked in a database at
1619
+ least until it expires.
1735
1620
 
1736
- * Optimize `remove_columns` to use a single SQL statement.
1621
+ With `generates_token_for`, a token can embed data from a record. When
1622
+ using the token to fetch the record, the data from the token and the current
1623
+ data from the record will be compared. If the two do not match, the token
1624
+ will be treated as invalid, the same as if it had expired. For example:
1737
1625
 
1738
1626
  ```ruby
1739
- remove_columns :my_table, :col_one, :col_two
1740
- ```
1627
+ class User < ActiveRecord::Base
1628
+ has_secure_password
1741
1629
 
1742
- Now results in the following SQL:
1630
+ generates_token_for :password_reset, expires_in: 15.minutes do
1631
+ # A password's BCrypt salt changes when the password is updated.
1632
+ # By embedding (part of) the salt in a token, the token will
1633
+ # expire when the password is updated.
1634
+ BCrypt::Password.new(password_digest).salt[-10..]
1635
+ end
1636
+ end
1743
1637
 
1744
- ```sql
1745
- ALTER TABLE "my_table" DROP COLUMN "col_one", DROP COLUMN "col_two"
1746
- ```
1638
+ user = User.first
1639
+ token = user.generate_token_for(:password_reset)
1747
1640
 
1748
- *Jon Dufresne*
1641
+ User.find_by_token_for(:password_reset, token) # => user
1749
1642
 
1750
- * Ensure `has_one` autosave association callbacks get called once.
1643
+ user.update!(password: "new password")
1644
+ User.find_by_token_for(:password_reset, token) # => nil
1645
+ ```
1751
1646
 
1752
- Change the `has_one` autosave callback to be non cyclic as well.
1753
- By doing this the autosave callback are made more consistent for
1754
- all 3 cases: `has_many`, `has_one`, and `belongs_to`.
1647
+ *Jonathan Hefner*
1755
1648
 
1756
- *Petrik de Heus*
1649
+ * Optimize Active Record batching for whole table iterations.
1757
1650
 
1758
- * Add option to disable joins for associations.
1651
+ Previously, `in_batches` got all the ids and constructed an `IN`-based query for each batch.
1652
+ When iterating over the whole tables, this approach is not optimal as it loads unneeded ids and
1653
+ `IN` queries with lots of items are slow.
1759
1654
 
1760
- In a multiple database application, associations can't join across
1761
- databases. When set, this option instructs Rails to generate 2 or
1762
- more queries rather than generating joins for associations.
1655
+ Now, whole table iterations use range iteration (`id >= x AND id <= y`) by default which can make iteration
1656
+ several times faster. E.g., tested on a PostgreSQL table with 10 million records: querying (`253s` vs `30s`),
1657
+ updating (`288s` vs `124s`), deleting (`268s` vs `83s`).
1763
1658
 
1764
- Set the option on a has many through association:
1659
+ Only whole table iterations use this style of iteration by default. You can disable this behavior by passing `use_ranges: false`.
1660
+ If you iterate over the table and the only condition is, e.g., `archived_at: nil` (and only a tiny fraction
1661
+ of the records are archived), it makes sense to opt in to this approach:
1765
1662
 
1766
1663
  ```ruby
1767
- class Dog
1768
- has_many :treats, through: :humans, disable_joins: true
1769
- has_many :humans
1664
+ Project.where(archived_at: nil).in_batches(use_ranges: true) do |relation|
1665
+ # do something
1770
1666
  end
1771
1667
  ```
1772
1668
 
1773
- Then instead of generating join SQL, two queries are used for `@dog.treats`:
1774
-
1775
- ```
1776
- SELECT "humans"."id" FROM "humans" WHERE "humans"."dog_id" = ? [["dog_id", 1]]
1777
- SELECT "treats".* FROM "treats" WHERE "treats"."human_id" IN (?, ?, ?) [["human_id", 1], ["human_id", 2], ["human_id", 3]]
1778
- ```
1779
-
1780
- *Eileen M. Uchitelle*, *Aaron Patterson*, *Lee Quarella*
1781
-
1782
- * Add setting for enumerating column names in SELECT statements.
1669
+ See #45414 for more details.
1783
1670
 
1784
- Adding a column to a PostgreSQL database, for example, while the application is running can
1785
- change the result of wildcard `SELECT *` queries, which invalidates the result
1786
- of cached prepared statements and raises a `PreparedStatementCacheExpired` error.
1787
-
1788
- When enabled, Active Record will avoid wildcards and always include column names
1789
- in `SELECT` queries, which will return consistent results and avoid prepared
1790
- statement errors.
1671
+ *fatkodima*
1791
1672
 
1792
- Before:
1673
+ * `.with` query method added. Construct common table expressions with ease and get `ActiveRecord::Relation` back.
1793
1674
 
1794
1675
  ```ruby
1795
- Book.limit(5)
1796
- # SELECT * FROM books LIMIT 5
1676
+ Post.with(posts_with_comments: Post.where("comments_count > ?", 0))
1677
+ # => ActiveRecord::Relation
1678
+ # WITH posts_with_comments AS (SELECT * FROM posts WHERE (comments_count > 0)) SELECT * FROM posts
1797
1679
  ```
1798
1680
 
1799
- After:
1800
-
1801
- ```ruby
1802
- # config/application.rb
1803
- module MyApp
1804
- class Application < Rails::Application
1805
- config.active_record.enumerate_columns_in_select_statements = true
1806
- end
1807
- end
1681
+ *Vlado Cingel*
1808
1682
 
1809
- # or, configure per-model
1810
- class Book < ApplicationRecord
1811
- self.enumerate_columns_in_select_statements = true
1812
- end
1813
- ```
1683
+ * Don't establish a new connection if an identical pool exists already.
1814
1684
 
1815
- ```ruby
1816
- Book.limit(5)
1817
- # SELECT id, author_id, name, format, status, language, etc FROM books LIMIT 5
1818
- ```
1685
+ Previously, if `establish_connection` was called on a class that already had an established connection, the existing connection would be removed regardless of whether it was the same config. Now if a pool is found with the same values as the new connection, the existing connection will be returned instead of creating a new one.
1819
1686
 
1820
- *Matt Duszynski*
1687
+ This has a slight change in behavior if application code is depending on a new connection being established regardless of whether it's identical to an existing connection. If the old behavior is desirable, applications should call `ActiveRecord::Base#remove_connection` before establishing a new one. Calling `establish_connection` with a different config works the same way as it did previously.
1821
1688
 
1822
- * Allow passing SQL as `on_duplicate` value to `#upsert_all` to make it possible to use raw SQL to update columns on conflict:
1689
+ *Eileen M. Uchitelle*
1823
1690
 
1824
- ```ruby
1825
- Book.upsert_all(
1826
- [{ id: 1, status: 1 }, { id: 2, status: 1 }],
1827
- on_duplicate: Arel.sql("status = GREATEST(books.status, EXCLUDED.status)")
1828
- )
1829
- ```
1691
+ * Update `db:prepare` task to load schema when an uninitialized database exists, and dump schema after migrations.
1830
1692
 
1831
- *Vladimir Dementyev*
1693
+ *Ben Sheldon*
1832
1694
 
1833
- * Allow passing SQL as `returning` statement to `#upsert_all`:
1695
+ * Fix supporting timezone awareness for `tsrange` and `tstzrange` array columns.
1834
1696
 
1835
1697
  ```ruby
1836
- Article.insert_all(
1837
- [
1838
- { title: "Article 1", slug: "article-1", published: false },
1839
- { title: "Article 2", slug: "article-2", published: false }
1840
- ],
1841
- returning: Arel.sql("id, (xmax = '0') as inserted, name as new_name")
1842
- )
1698
+ # In database migrations
1699
+ add_column :shops, :open_hours, :tsrange, array: true
1700
+ # In app config
1701
+ ActiveRecord::Base.time_zone_aware_types += [:tsrange]
1702
+ # In the code times are properly converted to app time zone
1703
+ Shop.create!(open_hours: [Time.current..8.hour.from_now])
1843
1704
  ```
1844
1705
 
1845
- *Vladimir Dementyev*
1706
+ *Wojciech Wnętrzak*
1846
1707
 
1847
- * Deprecate `legacy_connection_handling`.
1708
+ * Introduce strategy pattern for executing migrations.
1848
1709
 
1849
- *Eileen M. Uchitelle*
1710
+ By default, migrations will use a strategy object that delegates the method
1711
+ to the connection adapter. Consumers can implement custom strategy objects
1712
+ to change how their migrations run.
1850
1713
 
1851
- * Add attribute encryption support.
1714
+ *Adrianna Chang*
1852
1715
 
1853
- Encrypted attributes are declared at the model level. These
1854
- are regular Active Record attributes backed by a column with
1855
- the same name. The system will transparently encrypt these
1856
- attributes before saving them into the database and will
1857
- decrypt them when retrieving their values.
1716
+ * Add adapter option disallowing foreign keys
1858
1717
 
1718
+ This adds a new option to be added to `database.yml` which enables skipping
1719
+ foreign key constraints usage even if the underlying database supports them.
1859
1720
 
1860
- ```ruby
1861
- class Person < ApplicationRecord
1862
- encrypts :name
1863
- encrypts :email_address, deterministic: true
1864
- end
1721
+ Usage:
1722
+ ```yaml
1723
+ development:
1724
+ <<: *default
1725
+ database: storage/development.sqlite3
1726
+ foreign_keys: false
1865
1727
  ```
1866
1728
 
1867
- You can learn more in the [Active Record Encryption
1868
- guide](https://edgeguides.rubyonrails.org/active_record_encryption.html).
1729
+ *Paulo Barros*
1869
1730
 
1870
- *Jorge Manrubia*
1731
+ * Add configurable deprecation warning for singular associations
1871
1732
 
1872
- * Changed Arel predications `contains` and `overlaps` to use
1873
- `quoted_node` so that PostgreSQL arrays are quoted properly.
1733
+ This adds a deprecation warning when using the plural name of a singular associations in `where`.
1734
+ It is possible to opt into the new more performant behavior with `config.active_record.allow_deprecated_singular_associations_name = false`
1874
1735
 
1875
- *Bradley Priest*
1736
+ *Adam Hess*
1876
1737
 
1877
- * Add mode argument to record level `strict_loading!`.
1738
+ * Run transactional callbacks on the freshest instance to save a given
1739
+ record within a transaction.
1878
1740
 
1879
- This argument can be used when enabling strict loading for a single record
1880
- to specify that we only want to raise on n plus one queries.
1741
+ When multiple Active Record instances change the same record within a
1742
+ transaction, Rails runs `after_commit` or `after_rollback` callbacks for
1743
+ only one of them. `config.active_record.run_commit_callbacks_on_first_saved_instances_in_transaction`
1744
+ was added to specify how Rails chooses which instance receives the
1745
+ callbacks. The framework defaults were changed to use the new logic.
1881
1746
 
1882
- ```ruby
1883
- developer.strict_loading!(mode: :n_plus_one_only)
1747
+ When `config.active_record.run_commit_callbacks_on_first_saved_instances_in_transaction`
1748
+ is `true`, transactional callbacks are run on the first instance to save,
1749
+ even though its instance state may be stale.
1884
1750
 
1885
- developer.projects.to_a # Does not raise
1886
- developer.projects.first.client # Raises StrictLoadingViolationError
1887
- ```
1751
+ When it is `false`, which is the new framework default starting with version
1752
+ 7.1, transactional callbacks are run on the instances with the freshest
1753
+ instance state. Those instances are chosen as follows:
1888
1754
 
1889
- Previously, enabling strict loading would cause any lazily loaded
1890
- association to raise an error. Using `n_plus_one_only` mode allows us to
1891
- lazily load belongs_to, has_many, and other associations that are fetched
1892
- through a single query.
1755
+ - In general, run transactional callbacks on the last instance to save a
1756
+ given record within the transaction.
1757
+ - There are two exceptions:
1758
+ - If the record is created within the transaction, then updated by
1759
+ another instance, `after_create_commit` callbacks will be run on the
1760
+ second instance. This is instead of the `after_update_commit`
1761
+ callbacks that would naively be run based on that instance’s state.
1762
+ - If the record is destroyed within the transaction, then
1763
+ `after_destroy_commit` callbacks will be fired on the last destroyed
1764
+ instance, even if a stale instance subsequently performed an update
1765
+ (which will have affected 0 rows).
1893
1766
 
1894
- *Dinah Shi*
1767
+ *Cameron Bothner and Mitch Vollebregt*
1895
1768
 
1896
- * Fix Float::INFINITY assignment to datetime column with postgresql adapter.
1769
+ * Enable strict strings mode for `SQLite3Adapter`.
1897
1770
 
1898
- Before:
1771
+ Configures SQLite with a strict strings mode, which disables double-quoted string literals.
1899
1772
 
1900
- ```ruby
1901
- # With this config
1902
- ActiveRecord::Base.time_zone_aware_attributes = true
1773
+ SQLite has some quirks around double-quoted string literals.
1774
+ It first tries to consider double-quoted strings as identifier names, but if they don't exist
1775
+ it then considers them as string literals. Because of this, typos can silently go unnoticed.
1776
+ For example, it is possible to create an index for a non existing column.
1777
+ See [SQLite documentation](https://www.sqlite.org/quirks.html#double_quoted_string_literals_are_accepted) for more details.
1903
1778
 
1904
- # and the following schema:
1905
- create_table "postgresql_infinities" do |t|
1906
- t.datetime "datetime"
1907
- end
1779
+ If you don't want this behavior, you can disable it via:
1908
1780
 
1909
- # This test fails
1910
- record = PostgresqlInfinity.create!(datetime: Float::INFINITY)
1911
- assert_equal Float::INFINITY, record.datetime # record.datetime gets nil
1781
+ ```ruby
1782
+ # config/application.rb
1783
+ config.active_record.sqlite3_adapter_strict_strings_by_default = false
1912
1784
  ```
1913
1785
 
1914
- After this commit, `record.datetime` gets `Float::INFINITY` as expected.
1786
+ Fixes #27782.
1787
+
1788
+ *fatkodima*, *Jean Boussier*
1915
1789
 
1916
- *Shunichi Ikegami*
1790
+ * Resolve issue where a relation cache_version could be left stale.
1917
1791
 
1918
- * Type cast enum values by the original attribute type.
1792
+ Previously, when `reset` was called on a relation object it did not reset the cache_versions
1793
+ ivar. This led to a confusing situation where despite having the correct data the relation
1794
+ still reported a stale cache_version.
1919
1795
 
1920
- The notable thing about this change is that unknown labels will no longer match 0 on MySQL.
1796
+ Usage:
1921
1797
 
1922
1798
  ```ruby
1923
- class Book < ActiveRecord::Base
1924
- enum :status, { proposed: 0, written: 1, published: 2 }
1925
- end
1926
- ```
1799
+ developers = Developer.all
1800
+ developers.cache_version
1927
1801
 
1928
- Before:
1802
+ Developer.update_all(updated_at: Time.now.utc + 1.second)
1929
1803
 
1930
- ```ruby
1931
- # SELECT `books`.* FROM `books` WHERE `books`.`status` = 'prohibited' LIMIT 1
1932
- Book.find_by(status: :prohibited)
1933
- # => #<Book id: 1, status: "proposed", ...> (for mysql2 adapter)
1934
- # => ActiveRecord::StatementInvalid: PG::InvalidTextRepresentation: ERROR: invalid input syntax for type integer: "prohibited" (for postgresql adapter)
1935
- # => nil (for sqlite3 adapter)
1804
+ developers.cache_version # Stale cache_version
1805
+ developers.reset
1806
+ developers.cache_version # Returns the current correct cache_version
1936
1807
  ```
1937
1808
 
1938
- After:
1809
+ Fixes #45341.
1810
+
1811
+ *Austen Madden*
1812
+
1813
+ * Add support for exclusion constraints (PostgreSQL-only).
1939
1814
 
1940
1815
  ```ruby
1941
- # SELECT `books`.* FROM `books` WHERE `books`.`status` IS NULL LIMIT 1
1942
- Book.find_by(status: :prohibited)
1943
- # => nil (for all adapters)
1816
+ add_exclusion_constraint :invoices, "daterange(start_date, end_date) WITH &&", using: :gist, name: "invoices_date_overlap"
1817
+ remove_exclusion_constraint :invoices, name: "invoices_date_overlap"
1944
1818
  ```
1945
1819
 
1946
- *Ryuta Kamizono*
1820
+ See PostgreSQL's [`CREATE TABLE ... EXCLUDE ...`](https://www.postgresql.org/docs/12/sql-createtable.html#SQL-CREATETABLE-EXCLUDE) documentation for more on exclusion constraints.
1947
1821
 
1948
- * Fixtures for `has_many :through` associations now load timestamps on join tables.
1822
+ *Alex Robbin*
1949
1823
 
1950
- Given this fixture:
1824
+ * `change_column_null` raises if a non-boolean argument is provided
1951
1825
 
1952
- ```yml
1953
- ### monkeys.yml
1954
- george:
1955
- name: George the Monkey
1956
- fruits: apple
1826
+ Previously if you provided a non-boolean argument, `change_column_null` would
1827
+ treat it as truthy and make your column nullable. This could be surprising, so now
1828
+ the input must be either `true` or `false`.
1957
1829
 
1958
- ### fruits.yml
1959
- apple:
1960
- name: apple
1830
+ ```ruby
1831
+ change_column_null :table, :column, true # good
1832
+ change_column_null :table, :column, false # good
1833
+ change_column_null :table, :column, from: true, to: false # raises (previously this made the column nullable)
1961
1834
  ```
1962
1835
 
1963
- If the join table (`fruit_monkeys`) contains `created_at` or `updated_at` columns,
1964
- these will now be populated when loading the fixture. Previously, fixture loading
1965
- would crash if these columns were required, and leave them as null otherwise.
1966
-
1967
1836
  *Alex Ghiculescu*
1968
1837
 
1969
- * Allow applications to configure the thread pool for async queries.
1838
+ * Enforce limit on table names length.
1970
1839
 
1971
- Some applications may want one thread pool per database whereas others want to use
1972
- a single global thread pool for all queries. By default, Rails will set `async_query_executor`
1973
- to `nil` which will not initialize any executor. If `load_async` is called and no executor
1974
- has been configured, the query will be executed in the foreground.
1840
+ Fixes #45130.
1975
1841
 
1976
- To create one thread pool for all database connections to use applications can set
1977
- `config.active_record.async_query_executor` to `:global_thread_pool` and optionally define
1978
- `config.active_record.global_executor_concurrency`. This defaults to 4. For applications that want
1979
- to have a thread pool for each database connection, `config.active_record.async_query_executor` can
1980
- be set to `:multi_thread_pool`. The configuration for each thread pool is set in the database
1981
- configuration.
1842
+ *fatkodima*
1982
1843
 
1983
- *Eileen M. Uchitelle*
1844
+ * Adjust the minimum MariaDB version for check constraints support.
1984
1845
 
1985
- * Allow new syntax for `enum` to avoid leading `_` from reserved options.
1846
+ *Eddie Lebow*
1986
1847
 
1987
- Before:
1848
+ * Fix Hstore deserialize regression.
1988
1849
 
1989
- ```ruby
1990
- class Book < ActiveRecord::Base
1991
- enum status: [ :proposed, :written ], _prefix: true, _scopes: false
1992
- enum cover: [ :hard, :soft ], _suffix: true, _default: :hard
1993
- end
1994
- ```
1850
+ *edsharp*
1995
1851
 
1996
- After:
1852
+ * Add validity for PostgreSQL indexes.
1997
1853
 
1998
1854
  ```ruby
1999
- class Book < ActiveRecord::Base
2000
- enum :status, [ :proposed, :written ], prefix: true, scopes: false
2001
- enum :cover, [ :hard, :soft ], suffix: true, default: :hard
2002
- end
1855
+ connection.index_exists?(:users, :email, valid: true)
1856
+ connection.indexes(:users).select(&:valid?)
2003
1857
  ```
2004
1858
 
2005
- *Ryuta Kamizono*
1859
+ *fatkodima*
2006
1860
 
2007
- * Add `ActiveRecord::Relation#load_async`.
1861
+ * Fix eager loading for models without primary keys.
2008
1862
 
2009
- This method schedules the query to be performed asynchronously from a thread pool.
1863
+ *Anmol Chopra*, *Matt Lawrence*, and *Jonathan Hefner*
2010
1864
 
2011
- If the result is accessed before a background thread had the opportunity to perform
2012
- the query, it will be performed in the foreground.
1865
+ * Avoid validating a unique field if it has not changed and is backed by a unique index.
2013
1866
 
2014
- This is useful for queries that can be performed long enough before their result will be
2015
- needed, or for controllers which need to perform several independent queries.
1867
+ Previously, when saving a record, Active Record will perform an extra query to check for the
1868
+ uniqueness of each attribute having a `uniqueness` validation, even if that attribute hasn't changed.
1869
+ If the database has the corresponding unique index, then this validation can never fail for persisted
1870
+ records, and we could safely skip it.
2016
1871
 
2017
- ```ruby
2018
- def index
2019
- @categories = Category.some_complex_scope.load_async
2020
- @posts = Post.some_complex_scope.load_async
2021
- end
2022
- ```
1872
+ *fatkodima*
2023
1873
 
2024
- Active Record logs will also include timing info for the duration of how long
2025
- the main thread had to wait to access the result. This timing is useful to know
2026
- whether or not it's worth to load the query asynchronously.
1874
+ * Stop setting `sql_auto_is_null`
2027
1875
 
2028
- ```
2029
- DEBUG -- : Category Load (62.1ms) SELECT * FROM `categories` LIMIT 50
2030
- DEBUG -- : ASYNC Post Load (64ms) (db time 126.1ms) SELECT * FROM `posts` LIMIT 100
2031
- ```
1876
+ Since version 5.5 the default has been off, we no longer have to manually turn it off.
2032
1877
 
2033
- The duration in the first set of parens is how long the main thread was blocked
2034
- waiting for the results, and the second set of parens with "db time" is how long
2035
- the entire query took to execute.
1878
+ *Adam Hess*
2036
1879
 
2037
- *Jean Boussier*
1880
+ * Fix `touch` to raise an error for readonly columns.
2038
1881
 
2039
- * Implemented `ActiveRecord::Relation#excluding` method.
1882
+ *fatkodima*
2040
1883
 
2041
- This method excludes the specified record (or collection of records) from
2042
- the resulting relation:
1884
+ * Add ability to ignore tables by regexp for SQL schema dumps.
2043
1885
 
2044
1886
  ```ruby
2045
- Post.excluding(post)
2046
- Post.excluding(post_one, post_two)
1887
+ ActiveRecord::SchemaDumper.ignore_tables = [/^_/]
2047
1888
  ```
2048
1889
 
2049
- Also works on associations:
2050
-
2051
- ```ruby
2052
- post.comments.excluding(comment)
2053
- post.comments.excluding(comment_one, comment_two)
2054
- ```
1890
+ *fatkodima*
2055
1891
 
2056
- This is short-hand for `Post.where.not(id: post.id)` (for a single record)
2057
- and `Post.where.not(id: [post_one.id, post_two.id])` (for a collection).
1892
+ * Avoid queries when performing calculations on contradictory relations.
2058
1893
 
2059
- *Glen Crawford*
1894
+ Previously calculations would make a query even when passed a
1895
+ contradiction, such as `User.where(id: []).count`. We no longer perform a
1896
+ query in that scenario.
2060
1897
 
2061
- * Skip optimised #exist? query when #include? is called on a relation
2062
- with a having clause.
1898
+ This applies to the following calculations: `count`, `sum`, `average`,
1899
+ `minimum` and `maximum`
2063
1900
 
2064
- Relations that have aliased select values AND a having clause that
2065
- references an aliased select value would generate an error when
2066
- #include? was called, due to an optimisation that would generate
2067
- call #exists? on the relation instead, which effectively alters
2068
- the select values of the query (and thus removes the aliased select
2069
- values), but leaves the having clause intact. Because the having
2070
- clause is then referencing an aliased column that is no longer
2071
- present in the simplified query, an ActiveRecord::InvalidStatement
2072
- error was raised.
1901
+ *Luan Vieira, John Hawthorn and Daniel Colson*
2073
1902
 
2074
- A sample query affected by this problem:
1903
+ * Allow using aliased attributes with `insert_all`/`upsert_all`.
2075
1904
 
2076
1905
  ```ruby
2077
- Author.select('COUNT(*) as total_posts', 'authors.*')
2078
- .joins(:posts)
2079
- .group(:id)
2080
- .having('total_posts > 2')
2081
- .include?(Author.first)
1906
+ class Book < ApplicationRecord
1907
+ alias_attribute :title, :name
1908
+ end
1909
+
1910
+ Book.insert_all [{ title: "Remote", author_id: 1 }], returning: :title
2082
1911
  ```
2083
1912
 
2084
- This change adds an addition check to the condition that skips the
2085
- simplified #exists? query, which simply checks for the presence of
2086
- a having clause.
1913
+ *fatkodima*
2087
1914
 
2088
- Fixes #41417.
1915
+ * Support encrypted attributes on columns with default db values.
2089
1916
 
2090
- *Michael Smart*
1917
+ This adds support for encrypted attributes defined on columns with default values.
1918
+ It will encrypt those values at creation time. Before, it would raise an
1919
+ error unless `config.active_record.encryption.support_unencrypted_data` was true.
2091
1920
 
2092
- * Increment postgres prepared statement counter before making a prepared statement, so if the statement is aborted
2093
- without Rails knowledge (e.g., if app gets killed during long-running query or due to Rack::Timeout), app won't end
2094
- up in perpetual crash state for being inconsistent with PostgreSQL.
1921
+ *Jorge Manrubia* and *Dima Fatko*
2095
1922
 
2096
- *wbharding*, *Martin Tepper*
1923
+ * Allow overriding `reading_request?` in `DatabaseSelector::Resolver`
2097
1924
 
2098
- * Add ability to apply `scoping` to `all_queries`.
1925
+ The default implementation checks if a request is a `get?` or `head?`,
1926
+ but you can now change it to anything you like. If the method returns true,
1927
+ `Resolver#read` gets called meaning the request could be served by the
1928
+ replica database.
2099
1929
 
2100
- Some applications may want to use the `scoping` method but previously it only
2101
- worked on certain types of queries. This change allows the `scoping` method to apply
2102
- to all queries for a model in a block.
1930
+ *Alex Ghiculescu*
2103
1931
 
2104
- ```ruby
2105
- Post.where(blog_id: post.blog_id).scoping(all_queries: true) do
2106
- post.update(title: "a post title") # adds `posts.blog_id = 1` to the query
2107
- end
2108
- ```
1932
+ * Remove `ActiveRecord.legacy_connection_handling`.
2109
1933
 
2110
1934
  *Eileen M. Uchitelle*
2111
1935
 
2112
- * `ActiveRecord::Calculations.calculate` called with `:average`
2113
- (aliased as `ActiveRecord::Calculations.average`) will now use column-based
2114
- type casting. This means that floating-point number columns will now be
2115
- aggregated as `Float` and decimal columns will be aggregated as `BigDecimal`.
1936
+ * `rails db:schema:{dump,load}` now checks `ENV["SCHEMA_FORMAT"]` before config
2116
1937
 
2117
- Integers are handled as a special case returning `BigDecimal` always
2118
- (this was the case before already).
1938
+ Since `rails db:structure:{dump,load}` was deprecated there wasn't a simple
1939
+ way to dump a schema to both SQL and Ruby formats. You can now do this with
1940
+ an environment variable. For example:
2119
1941
 
2120
- ```ruby
2121
- # With the following schema:
2122
- create_table "measurements" do |t|
2123
- t.float "temperature"
2124
- end
1942
+ ```
1943
+ SCHEMA_FORMAT=sql rake db:schema:dump
1944
+ ```
2125
1945
 
2126
- # Before:
2127
- Measurement.average(:temperature).class
2128
- # => BigDecimal
1946
+ *Alex Ghiculescu*
2129
1947
 
2130
- # After:
2131
- Measurement.average(:temperature).class
2132
- # => Float
2133
- ```
1948
+ * Fixed MariaDB default function support.
1949
+
1950
+ Defaults would be written wrong in "db/schema.rb" and not work correctly
1951
+ if using `db:schema:load`. Further more the function name would be
1952
+ added as string content when saving new records.
2134
1953
 
2135
- Before this change, Rails just called `to_d` on average aggregates from the
2136
- database adapter. This is not the case anymore. If you relied on that kind
2137
- of magic, you now need to register your own `ActiveRecord::Type`
2138
- (see `ActiveRecord::Attributes::ClassMethods` for documentation).
1954
+ *kaspernj*
2139
1955
 
2140
- *Josua Schmid*
1956
+ * Add `active_record.destroy_association_async_batch_size` configuration
2141
1957
 
2142
- * PostgreSQL: introduce `ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.datetime_type`.
1958
+ This allows applications to specify the maximum number of records that will
1959
+ be destroyed in a single background job by the `dependent: :destroy_async`
1960
+ association option. By default, the current behavior will remain the same:
1961
+ when a parent record is destroyed, all dependent records will be destroyed
1962
+ in a single background job. If the number of dependent records is greater
1963
+ than this configuration, the records will be destroyed in multiple
1964
+ background jobs.
2143
1965
 
2144
- This setting controls what native type Active Record should use when you call `datetime` in
2145
- a migration or schema. It takes a symbol which must correspond to one of the configured
2146
- `NATIVE_DATABASE_TYPES`. The default is `:timestamp`, meaning `t.datetime` in a migration
2147
- will create a "timestamp without time zone" column. To use "timestamp with time zone",
2148
- change this to `:timestamptz` in an initializer.
1966
+ *Nick Holden*
2149
1967
 
2150
- You should run `bin/rails db:migrate` to rebuild your schema.rb if you change this.
1968
+ * Fix `remove_foreign_key` with `:if_exists` option when foreign key actually exists.
2151
1969
 
2152
- *Alex Ghiculescu*
1970
+ *fatkodima*
1971
+
1972
+ * Remove `--no-comments` flag in structure dumps for PostgreSQL
2153
1973
 
2154
- * PostgreSQL: handle `timestamp with time zone` columns correctly in `schema.rb`.
1974
+ This broke some apps that used custom schema comments. If you don't want
1975
+ comments in your structure dump, you can use:
2155
1976
 
2156
- Previously they dumped as `t.datetime :column_name`, now they dump as `t.timestamptz :column_name`,
2157
- and are created as `timestamptz` columns when the schema is loaded.
1977
+ ```ruby
1978
+ ActiveRecord::Tasks::DatabaseTasks.structure_dump_flags = ['--no-comments']
1979
+ ```
2158
1980
 
2159
1981
  *Alex Ghiculescu*
2160
1982
 
2161
- * Removing trailing whitespace when matching columns in
2162
- `ActiveRecord::Sanitization.disallow_raw_sql!`.
1983
+ * Reduce the memory footprint of fixtures accessors.
2163
1984
 
2164
- *Gannon McGibbon*, *Adrian Hirt*
1985
+ Until now fixtures accessors were eagerly defined using `define_method`.
1986
+ So the memory usage was directly dependent of the number of fixtures and
1987
+ test suites.
2165
1988
 
2166
- * Expose a way for applications to set a `primary_abstract_class`.
1989
+ Instead fixtures accessors are now implemented with `method_missing`,
1990
+ so they incur much less memory and CPU overhead.
2167
1991
 
2168
- Multiple database applications that use a primary abstract class that is not
2169
- named `ApplicationRecord` can now set a specific class to be the `primary_abstract_class`.
1992
+ *Jean Boussier*
2170
1993
 
2171
- ```ruby
2172
- class PrimaryApplicationRecord
2173
- self.primary_abstract_class
2174
- end
2175
- ```
1994
+ * Fix `config.active_record.destroy_association_async_job` configuration
2176
1995
 
2177
- When an application boots it automatically connects to the primary or first database in the
2178
- database configuration file. In a multiple database application that then call `connects_to`
2179
- needs to know that the default connection is the same as the `ApplicationRecord` connection.
2180
- However, some applications have a differently named `ApplicationRecord`. This prevents Active
2181
- Record from opening duplicate connections to the same database.
1996
+ `config.active_record.destroy_association_async_job` should allow
1997
+ applications to specify the job that will be used to destroy associated
1998
+ records in the background for `has_many` associations with the
1999
+ `dependent: :destroy_async` option. Previously, that was ignored, which
2000
+ meant the default `ActiveRecord::DestroyAssociationAsyncJob` always
2001
+ destroyed records in the background.
2182
2002
 
2183
- *Eileen M. Uchitelle*, *John Crepezzi*
2003
+ *Nick Holden*
2184
2004
 
2185
- * Support hash config for `structure_dump_flags` and `structure_load_flags` flags.
2186
- Now that Active Record supports multiple databases configuration,
2187
- we need a way to pass specific flags for dump/load databases since
2188
- the options are not the same for different adapters.
2189
- We can use in the original way:
2005
+ * Fix `change_column_comment` to preserve column's AUTO_INCREMENT in the MySQL adapter
2190
2006
 
2191
- ```ruby
2192
- ActiveRecord::Tasks::DatabaseTasks.structure_dump_flags = ['--no-defaults', '--skip-add-drop-table']
2193
- # or
2194
- ActiveRecord::Tasks::DatabaseTasks.structure_dump_flags = '--no-defaults --skip-add-drop-table'
2195
- ```
2007
+ *fatkodima*
2196
2008
 
2197
- And also use it passing a hash, with one or more keys, where the key
2198
- is the adapter
2009
+ * Fix quoting of `ActiveSupport::Duration` and `Rational` numbers in the MySQL adapter.
2199
2010
 
2200
- ```ruby
2201
- ActiveRecord::Tasks::DatabaseTasks.structure_dump_flags = {
2202
- mysql2: ['--no-defaults', '--skip-add-drop-table'],
2203
- postgres: '--no-tablespaces'
2204
- }
2205
- ```
2011
+ *Kevin McPhillips*
2206
2012
 
2207
- *Gustavo Gonzalez*
2013
+ * Allow column name with COLLATE (e.g., title COLLATE "C") as safe SQL string
2208
2014
 
2209
- * Connection specification now passes the "url" key as a configuration for the
2210
- adapter if the "url" protocol is "jdbc", "http", or "https". Previously only
2211
- urls with the "jdbc" prefix were passed to the Active Record Adapter, others
2212
- are assumed to be adapter specification urls.
2015
+ *Shugo Maeda*
2213
2016
 
2214
- Fixes #41137.
2017
+ * Permit underscores in the VERSION argument to database rake tasks.
2215
2018
 
2216
- *Jonathan Bracy*
2019
+ *Eddie Lebow*
2217
2020
 
2218
- * Allow to opt-out of `strict_loading` mode on a per-record base.
2021
+ * Reversed the order of `INSERT` statements in `structure.sql` dumps
2219
2022
 
2220
- This is useful when strict loading is enabled application wide or on a
2221
- model level.
2023
+ This should decrease the likelihood of merge conflicts. New migrations
2024
+ will now be added at the top of the list.
2222
2025
 
2223
- ```ruby
2224
- class User < ApplicationRecord
2225
- has_many :bookmarks
2226
- has_many :articles, strict_loading: true
2227
- end
2026
+ For existing apps, there will be a large diff the next time `structure.sql`
2027
+ is generated.
2228
2028
 
2229
- user = User.first
2230
- user.articles # => ActiveRecord::StrictLoadingViolationError
2231
- user.bookmarks # => #<ActiveRecord::Associations::CollectionProxy>
2029
+ *Alex Ghiculescu*, *Matt Larraz*
2232
2030
 
2233
- user.strict_loading!(true) # => true
2234
- user.bookmarks # => ActiveRecord::StrictLoadingViolationError
2031
+ * Fix PG.connect keyword arguments deprecation warning on ruby 2.7
2235
2032
 
2236
- user.strict_loading!(false) # => false
2237
- user.bookmarks # => #<ActiveRecord::Associations::CollectionProxy>
2238
- user.articles.strict_loading!(false) # => #<ActiveRecord::Associations::CollectionProxy>
2239
- ```
2033
+ Fixes #44307.
2240
2034
 
2241
- *Ayrton De Craene*
2035
+ *Nikita Vasilevsky*
2242
2036
 
2243
- * Add `FinderMethods#sole` and `#find_sole_by` to find and assert the
2244
- presence of exactly one record.
2037
+ * Fix dropping DB connections after serialization failures and deadlocks.
2245
2038
 
2246
- Used when you need a single row, but also want to assert that there aren't
2247
- multiple rows matching the condition; especially for when database
2248
- constraints aren't enough or are impractical.
2039
+ Prior to 6.1.4, serialization failures and deadlocks caused rollbacks to be
2040
+ issued for both real transactions and savepoints. This breaks MySQL which
2041
+ disallows rollbacks of savepoints following a deadlock.
2249
2042
 
2250
- ```ruby
2251
- Product.where(["price = %?", price]).sole
2252
- # => ActiveRecord::RecordNotFound (if no Product with given price)
2253
- # => #<Product ...> (if one Product with given price)
2254
- # => ActiveRecord::SoleRecordExceeded (if more than one Product with given price)
2043
+ 6.1.4 removed these rollbacks, for both transactions and savepoints, causing
2044
+ the DB connection to be left in an unknown state and thus discarded.
2255
2045
 
2256
- user.api_keys.find_sole_by(key: key)
2257
- # as above
2258
- ```
2046
+ These rollbacks are now restored, except for savepoints on MySQL.
2259
2047
 
2260
- *Asherah Connor*
2048
+ *Thomas Morgan*
2261
2049
 
2262
- * Makes `ActiveRecord::AttributeMethods::Query` respect the getter overrides defined in the model.
2050
+ * Make `ActiveRecord::ConnectionPool` Fiber-safe
2263
2051
 
2264
- Before:
2052
+ When `ActiveSupport::IsolatedExecutionState.isolation_level` is set to `:fiber`,
2053
+ the connection pool now supports multiple Fibers from the same Thread checking
2054
+ out connections from the pool.
2055
+
2056
+ *Alex Matchneer*
2057
+
2058
+ * Add `update_attribute!` to `ActiveRecord::Persistence`
2059
+
2060
+ Similar to `update_attribute`, but raises `ActiveRecord::RecordNotSaved` when a `before_*` callback throws `:abort`.
2265
2061
 
2266
2062
  ```ruby
2267
- class User
2268
- def admin
2269
- false # Overriding the getter to always return false
2063
+ class Topic < ActiveRecord::Base
2064
+ before_save :check_title
2065
+
2066
+ def check_title
2067
+ throw(:abort) if title == "abort"
2270
2068
  end
2271
2069
  end
2272
2070
 
2273
- user = User.first
2274
- user.update(admin: true)
2275
-
2276
- user.admin # false (as expected, due to the getter overwrite)
2277
- user.admin? # true (not expected, returned the DB column value)
2071
+ topic = Topic.create(title: "Test Title")
2072
+ # #=> #<Topic title: "Test Title">
2073
+ topic.update_attribute!(:title, "Another Title")
2074
+ # #=> #<Topic title: "Another Title">
2075
+ topic.update_attribute!(:title, "abort")
2076
+ # raises ActiveRecord::RecordNotSaved
2278
2077
  ```
2279
2078
 
2280
- After this commit, `user.admin?` above returns false, as expected.
2079
+ *Drew Tempelmeyer*
2281
2080
 
2282
- Fixes #40771.
2081
+ * Avoid loading every record in `ActiveRecord::Relation#pretty_print`
2283
2082
 
2284
- *Felipe*
2083
+ ```ruby
2084
+ # Before
2085
+ pp Foo.all # Loads the whole table.
2086
+
2087
+ # After
2088
+ pp Foo.all # Shows 10 items and an ellipsis.
2089
+ ```
2285
2090
 
2286
- * Allow delegated_type to be specified primary_key and foreign_key.
2091
+ *Ulysse Buonomo*
2287
2092
 
2288
- Since delegated_type assumes that the foreign_key ends with `_id`,
2289
- `singular_id` defined by it does not work when the foreign_key does
2290
- not end with `id`. This change fixes it by taking into account
2291
- `primary_key` and `foreign_key` in the options.
2093
+ * Change `QueryMethods#in_order_of` to drop records not listed in values.
2292
2094
 
2293
- *Ryota Egusa*
2095
+ `in_order_of` now filters down to the values provided, to match the behavior of the `Enumerable` version.
2294
2096
 
2295
- * Expose an `invert_where` method that will invert all scope conditions.
2097
+ *Kevin Newton*
2296
2098
 
2297
- ```ruby
2298
- class User
2299
- scope :active, -> { where(accepted: true, locked: false) }
2300
- end
2099
+ * Allow named expression indexes to be revertible.
2301
2100
 
2302
- User.active
2303
- # ... WHERE `accepted` = 1 AND `locked` = 0
2101
+ Previously, the following code would raise an error in a reversible migration executed while rolling back, due to the index name not being used in the index removal.
2304
2102
 
2305
- User.active.invert_where
2306
- # ... WHERE NOT (`accepted` = 1 AND `locked` = 0)
2103
+ ```ruby
2104
+ add_index(:settings, "(data->'property')", using: :gin, name: :index_settings_data_property)
2307
2105
  ```
2308
2106
 
2309
- *Kevin Deisz*
2107
+ Fixes #43331.
2108
+
2109
+ *Oliver Günther*
2310
2110
 
2311
- * Restore possibility of passing `false` to :polymorphic option of `belongs_to`.
2111
+ * Fix incorrect argument in PostgreSQL structure dump tasks.
2312
2112
 
2313
- Previously, passing `false` would trigger the option validation logic
2314
- to throw an error saying :polymorphic would not be a valid option.
2113
+ Updating the `--no-comment` argument added in Rails 7 to the correct `--no-comments` argument.
2315
2114
 
2316
- *glaszig*
2115
+ *Alex Dent*
2317
2116
 
2318
- * Remove deprecated `database` kwarg from `connected_to`.
2117
+ * Fix migration compatibility to create SQLite references/belongs_to column as integer when migration version is 6.0.
2319
2118
 
2320
- *Eileen M. Uchitelle*, *John Crepezzi*
2119
+ Reference/belongs_to in migrations with version 6.0 were creating columns as
2120
+ bigint instead of integer for the SQLite Adapter.
2321
2121
 
2322
- * Allow adding nonnamed expression indexes to be revertible.
2122
+ *Marcelo Lauxen*
2323
2123
 
2324
- Previously, the following code would raise an error, when executed while rolling back,
2325
- and the index name should be specified explicitly. Now, the index name is inferred
2326
- automatically.
2124
+ * Fix `QueryMethods#in_order_of` to handle empty order list.
2327
2125
 
2328
2126
  ```ruby
2329
- add_index(:items, "to_tsvector('english', description)")
2127
+ Post.in_order_of(:id, []).to_a
2330
2128
  ```
2331
2129
 
2332
- Fixes #40732.
2333
-
2334
- *fatkodima*
2335
-
2336
- * Only warn about negative enums if a positive form that would cause conflicts exists.
2337
-
2338
- Fixes #39065.
2339
-
2340
- *Alex Ghiculescu*
2130
+ Also more explicitly set the column as secondary order, so that any other
2131
+ value is still ordered.
2341
2132
 
2342
- * Add option to run `default_scope` on all queries.
2133
+ *Jean Boussier*
2343
2134
 
2344
- Previously, a `default_scope` would only run on select or insert queries. In some cases, like non-Rails tenant sharding solutions, it may be desirable to run `default_scope` on all queries in order to ensure queries are including a foreign key for the shard (i.e. `blog_id`).
2135
+ * Fix quoting of column aliases generated by calculation methods.
2345
2136
 
2346
- Now applications can add an option to run on all queries including select, insert, delete, and update by adding an `all_queries` option to the default scope definition.
2137
+ Since the alias is derived from the table name, we can't assume the result
2138
+ is a valid identifier.
2347
2139
 
2348
2140
  ```ruby
2349
- class Article < ApplicationRecord
2350
- default_scope -> { where(blog_id: Current.blog.id) }, all_queries: true
2141
+ class Test < ActiveRecord::Base
2142
+ self.table_name = '1abc'
2351
2143
  end
2144
+ Test.group(:id).count
2145
+ # syntax error at or near "1" (ActiveRecord::StatementInvalid)
2146
+ # LINE 1: SELECT COUNT(*) AS count_all, "1abc"."id" AS 1abc_id FROM "1...
2352
2147
  ```
2353
2148
 
2354
- *Eileen M. Uchitelle*
2149
+ *Jean Boussier*
2355
2150
 
2356
- * Add `where.associated` to check for the presence of an association.
2151
+ * Add `authenticate_by` when using `has_secure_password`.
2357
2152
 
2358
- ```ruby
2359
- # Before:
2360
- account.users.joins(:contact).where.not(contact_id: nil)
2153
+ `authenticate_by` is intended to replace code like the following, which
2154
+ returns early when a user with a matching email is not found:
2361
2155
 
2362
- # After:
2363
- account.users.where.associated(:contact)
2156
+ ```ruby
2157
+ User.find_by(email: "...")&.authenticate("...")
2364
2158
  ```
2365
2159
 
2366
- Also mirrors `where.missing`.
2160
+ Such code is vulnerable to timing-based enumeration attacks, wherein an
2161
+ attacker can determine if a user account with a given email exists. After
2162
+ confirming that an account exists, the attacker can try passwords associated
2163
+ with that email address from other leaked databases, in case the user
2164
+ re-used a password across multiple sites (a common practice). Additionally,
2165
+ knowing an account email address allows the attacker to attempt a targeted
2166
+ phishing ("spear phishing") attack.
2367
2167
 
2368
- *Kasper Timm Hansen*
2168
+ `authenticate_by` addresses the vulnerability by taking the same amount of
2169
+ time regardless of whether a user with a matching email is found:
2369
2170
 
2370
- * Allow constructors (`build_association` and `create_association`) on
2371
- `has_one :through` associations.
2171
+ ```ruby
2172
+ User.authenticate_by(email: "...", password: "...")
2173
+ ```
2372
2174
 
2373
- *Santiago Perez Perret*
2175
+ *Jonathan Hefner*
2374
2176
 
2375
2177
 
2376
- Please check [6-1-stable](https://github.com/rails/rails/blob/6-1-stable/activerecord/CHANGELOG.md) for previous changes.
2178
+ Please check [7-0-stable](https://github.com/rails/rails/blob/7-0-stable/activerecord/CHANGELOG.md) for previous changes.