activerecord 7.0.7.2 → 7.1.0.beta1

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