activerecord 7.0.6 → 7.1.3.4

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