activerecord 7.0.6 → 7.1.1

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