activerecord 7.0.5 → 7.1.3.4

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