activerecord 7.0.8 → 7.1.2

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