activerecord 7.0.6 → 7.1.0.beta1

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