CHANGELOG.md 31.5 KB
Newer Older
1 2 3 4 5 6
*   `connects_to` can only be called on `ActiveRecord::Base` or abstract classes.

    Ensure that `connects_to` can only be called from `ActiveRecord::Base` or abstract classes. This protects the application from opening duplicate or too many connections.

    *Eileen M. Uchitelle*, *John Crepezzi*

7
*   All connection adapters `execute` now raises `ActiveRecord::ConnectionNotEstablished` rather than
8
    `ActiveRecord::StatementInvalid` when they encounter a connection error.
9 10 11 12

    *Jean Boussier*

*   `Mysql2Adapter#quote_string` now raises `ActiveRecord::ConnectionNotEstablished` rather than
13
    `ActiveRecord::StatementInvalid` when it can't connect to the MySQL server.
14 15 16

    *Jean Boussier*

17 18 19 20
*   Add support for check constraints that are `NOT VALID` via `validate: false` (PostgreSQL-only).

    *Alex Robbin*

21 22 23 24 25 26
*   Ensure the default configuration is considered primary or first for an environment

    If a multiple database application provides a configuration named primary, that will be treated as default. In applications that do not have a primary entry, the default database configuration will be the first configuration for an environment.

    *Eileen M. Uchitelle*

27 28 29 30 31 32 33 34 35 36 37 38 39 40
*   Allow `where` references association names as joined table name aliases.

    ```ruby
    class Comment < ActiveRecord::Base
      enum label: [:default, :child]
      has_many :children, class_name: "Comment", foreign_key: :parent_id
    end

    # ... FROM comments LEFT OUTER JOIN comments children ON ... WHERE children.label = 1
    Comment.includes(:children).where("children.label": "child")
    ```

    *Ryuta Kamizono*

41 42 43 44 45 46 47 48 49
*   Support storing demodulized class name for polymorphic type.

    Before Rails 6.1, storing demodulized class name is supported only for STI type
    by `store_full_sti_class` class attribute.

    Now `store_full_class_name` class attribute can handle both STI and polymorphic types.

    *Ryuta Kamizono*

50 51 52 53 54 55
*   Deprecate `rails db:structure:{load, dump}` tasks and extend
    `rails db:schema:{load, dump}` tasks to work with either `:ruby` or `:sql` format,
    depending on `config.active_record.schema_format` configuration value.

    *fatkodima*

56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
*   Respect the `select` values for eager loading.

    ```ruby
    post = Post.select("UPPER(title) AS title").first
    post.title # => "WELCOME TO THE WEBLOG"
    post.body  # => ActiveModel::MissingAttributeError

    # Rails 6.0 (ignore the `select` values)
    post = Post.select("UPPER(title) AS title").eager_load(:comments).first
    post.title # => "Welcome to the weblog"
    post.body  # => "Such a lovely day"

    # Rails 6.1 (respect the `select` values)
    post = Post.select("UPPER(title) AS title").eager_load(:comments).first
    post.title # => "WELCOME TO THE WEBLOG"
    post.body  # => ActiveModel::MissingAttributeError
    ```

    *Ryuta Kamizono*

76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
*   Allow attribute's default to be configured but keeping its own type.

    ```ruby
    class Post < ActiveRecord::Base
      attribute :written_at, default: -> { Time.now.utc }
    end

    # Rails 6.0
    Post.type_for_attribute(:written_at) # => #<Type::Value ... precision: nil, ...>

    # Rails 6.1
    Post.type_for_attribute(:written_at) # => #<Type::DateTime ... precision: 6, ...>
    ```

    *Ryuta Kamizono*

92 93 94 95 96 97 98 99 100 101 102 103
*   Allow default to be configured for Enum.

    ```ruby
    class Book < ActiveRecord::Base
      enum status: [:proposed, :written, :published], _default: :published
    end

    Book.new.status # => "published"
    ```

    *Ryuta Kamizono*

104 105 106 107
*   Deprecate YAML loading from legacy format older than Rails 5.0.

    *Ryuta Kamizono*

108 109 110 111 112 113 114
*   Added the setting `ActiveRecord::Base.immutable_strings_by_default`, which
    allows you to specify that all string columns should be frozen unless
    otherwise specified. This will reduce memory pressure for applications which
    do not generally mutate string properties of Active Record objects.

    *Sean Griffin*

115 116 117 118
*   Deprecate `map!` and `collect!` on `ActiveRecord::Result`.

    *Ryuta Kamizono*

119 120 121 122
*   Support `relation.and` for intersection as Set theory.

    ```ruby
    david_and_mary = Author.where(id: [david, mary])
R
Ryuta Kamizono 已提交
123
    mary_and_bob   = Author.where(id: [mary, bob])
124 125 126 127 128 129 130 131 132

    david_and_mary.merge(mary_and_bob) # => [mary, bob]

    david_and_mary.and(mary_and_bob) # => [mary]
    david_and_mary.or(mary_and_bob)  # => [david, mary, bob]
    ```

    *Ryuta Kamizono*

133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
*   Merging conditions on the same column no longer maintain both conditions,
    and will be consistently replaced by the latter condition in Rails 6.2.
    To migrate to Rails 6.2's behavior, use `relation.merge(other, rewhere: true)`.

    ```ruby
    # Rails 6.1 (IN clause is replaced by merger side equality condition)
    Author.where(id: [david.id, mary.id]).merge(Author.where(id: bob)) # => [bob]

    # Rails 6.1 (both conflict conditions exists, deprecated)
    Author.where(id: david.id..mary.id).merge(Author.where(id: bob)) # => []

    # Rails 6.1 with rewhere to migrate to Rails 6.2's behavior
    Author.where(id: david.id..mary.id).merge(Author.where(id: bob), rewhere: true) # => [bob]

    # Rails 6.2 (same behavior with IN clause, mergee side condition is consistently replaced)
    Author.where(id: [david.id, mary.id]).merge(Author.where(id: bob)) # => [bob]
    Author.where(id: david.id..mary.id).merge(Author.where(id: bob)) # => [bob]
    ```

    *Ryuta Kamizono*

154 155 156 157
*   Do not mark Postgresql MAC address and UUID attributes as changed when the assigned value only varies by case.

    *Peter Fry*

158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
*   Resolve issue with insert_all unique_by option when used with expression index.

    When the `:unique_by` option of `ActiveRecord::Persistence.insert_all` and
    `ActiveRecord::Persistence.upsert_all` was used with the name of an expression index, an error
    was raised. Adding a guard around the formatting behavior for the `:unique_by` corrects this.

    Usage:

    ```ruby
    create_table :books, id: :integer, force: true do |t|
      t.column :name, :string
      t.index "lower(name)", unique: true
    end

    Book.insert_all [{ name: "MyTest" }], unique_by: :index_books_on_lower_name
    ```

    Fixes #39516.

    *Austen Madden*

179 180 181 182 183 184 185 186 187 188 189
*   Add basic support for CHECK constraints to database migrations.

    Usage:

    ```ruby
    add_check_constraint :products, "price > 0", name: "price_check"
    remove_check_constraint :products, name: "price_check"
    ```

    *fatkodima*

190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
*   Add `ActiveRecord::Base.strict_loading_by_default` and `ActiveRecord::Base.strict_loading_by_default=`
    to enable/disable strict_loading mode by default for a model. The configuration's value is
    inheritable by subclasses, but they can override that value and it will not impact parent class.

    Usage:

    ```ruby
    class Developer < ApplicationRecord
      self.strict_loading_by_default = true

      has_many :projects
    end

    dev = Developer.first
    dev.projects.first
    # => ActiveRecord::StrictLoadingViolationError Exception: Developer is marked as strict_loading and Project cannot be lazily loaded.
    ```

    *bogdanvlviv*

210 211 212 213
*   Deprecate passing an Active Record object to `quote`/`type_cast` directly.

    *Ryuta Kamizono*

214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
*   Default engine `ENGINE=InnoDB` is no longer dumped to make schema more agnostic.

    Before:

    ```ruby
    create_table "accounts", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci", force: :cascade do |t|
    end
    ```

    After:

    ```ruby
    create_table "accounts", charset: "utf8mb4", collation: "utf8mb4_0900_ai_ci", force: :cascade do |t|
    end
    ```

    *Ryuta Kamizono*

232 233
*   Added delegated type as an alternative to single-table inheritance for representing class hierarchies.
    See ActiveRecord::DelegatedType for the full description.
234

235 236
    *DHH*

237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
*   Deprecate aggregations with group by duplicated fields.

    To migrate to Rails 6.2's behavior, use `uniq!(:group)` to deduplicate group fields.

    ```ruby
    accounts = Account.group(:firm_id)

    # duplicated group fields, deprecated.
    accounts.merge(accounts.where.not(credit_limit: nil)).sum(:credit_limit)
    # => {
    #   [1, 1] => 50,
    #   [2, 2] => 60
    # }

    # use `uniq!(:group)` to deduplicate group fields.
    accounts.merge(accounts.where.not(credit_limit: nil)).uniq!(:group).sum(:credit_limit)
    # => {
    #   1 => 50,
    #   2 => 60
    # }
    ```

    *Ryuta Kamizono*

*   Deprecate duplicated query annotations.

    To migrate to Rails 6.2's behavior, use `uniq!(:annotate)` to deduplicate query annotations.

    ```ruby
    accounts = Account.where(id: [1, 2]).annotate("david and mary")

    # duplicated annotations, deprecated.
    accounts.merge(accounts.rewhere(id: 3))
    # SELECT accounts.* FROM accounts WHERE accounts.id = 3 /* david and mary */ /* david and mary */

    # use `uniq!(:annotate)` to deduplicate annotations.
    accounts.merge(accounts.rewhere(id: 3)).uniq!(:annotate)
    # SELECT accounts.* FROM accounts WHERE accounts.id = 3 /* david and mary */
    ```

    *Ryuta Kamizono*

279 280 281 282 283 284 285 286 287 288 289
*   Resolve conflict between counter cache and optimistic locking.

    Bump an Active Record instance's lock version after updating its counter
    cache. This avoids raising an unnecessary `ActiveRecord::StaleObjectError`
    upon subsequent transactions by maintaining parity with the corresponding
    database record's `lock_version` column.

    Fixes #16449.

    *Aaron Lipman*

290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
*   Support merging option `:rewhere` to allow mergee side condition to be replaced exactly.

    ```ruby
    david_and_mary = Author.where(id: david.id..mary.id)

    # both conflict conditions exists
    david_and_mary.merge(Author.where(id: bob)) # => []

    # mergee side condition is replaced by rewhere
    david_and_mary.merge(Author.rewhere(id: bob)) # => [bob]

    # mergee side condition is replaced by rewhere option
    david_and_mary.merge(Author.where(id: bob), rewhere: true) # => [bob]
    ```

    *Ryuta Kamizono*

307
*   Add support for finding records based on signed ids, which are tamper-proof, verified ids that can be
308 309
    set to expire and scoped with a purpose. This is particularly useful for things like password reset
    or email verification, where you want the bearer of the signed id to be able to interact with the
310
    underlying record, but usually only within a certain time period.
311

312 313
    ```ruby
    signed_id = User.first.signed_id expires_in: 15.minutes, purpose: :password_reset
314

315
    User.find_signed signed_id # => nil, since the purpose does not match
316

317 318
    travel 16.minutes
    User.find_signed signed_id, purpose: :password_reset # => nil, since the signed id has expired
319

320 321 322 323 324
    travel_back
    User.find_signed signed_id, purpose: :password_reset # => User.first

    User.find_signed! "bad data" # => ActiveSupport::MessageVerifier::InvalidSignature
    ```
325

326 327
    *DHH*

328 329 330 331
*   Support `ALGORITHM = INSTANT` DDL option for index operations on MySQL.

    *Ryuta Kamizono*

332 333 334 335
*   Fix index creation to preserve index comment in bulk change table on MySQL.

    *Ryuta Kamizono*

336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
*   Allow `unscope` to be aware of table name qualified values.

    It is possible to unscope only the column in the specified table.

    ```ruby
    posts = Post.joins(:comments).group(:"posts.hidden")
    posts = posts.where("posts.hidden": false, "comments.hidden": false)

    posts.count
    # => { false => 10 }

    # unscope both hidden columns
    posts.unscope(where: :hidden).count
    # => { false => 11, true => 1 }

    # unscope only comments.hidden column
    posts.unscope(where: :"comments.hidden").count
    # => { false => 11 }
    ```

    *Ryuta Kamizono*, *Slava Korolev*

358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
*   Fix `rewhere` to truly overwrite collided where clause by new where clause.

    ```ruby
    steve = Person.find_by(name: "Steve")
    david = Author.find_by(name: "David")

    relation = Essay.where(writer: steve)

    # Before
    relation.rewhere(writer: david).to_a # => []

    # After
    relation.rewhere(writer: david).to_a # => [david]
    ```

    *Ryuta Kamizono*

A
akinomaeni 已提交
375 376 377 378 379 380 381 382 383
*   Inspect time attributes with subsec.

    ```ruby
    p Knot.create
    => #<Knot id: 1, created_at: "2016-05-05 01:29:47.116928000">
    ```

    *akinomaeni*

384 385 386 387
*   Deprecate passing a column to `type_cast`.

    *Ryuta Kamizono*

388
*   Deprecate `in_clause_length` and `allowed_index_name_length` in `DatabaseLimits`.
389 390 391

    *Ryuta Kamizono*

392 393 394 395
*   Support bulk insert/upsert on relation to preserve scope values.

    *Josef Šimánek*, *Ryuta Kamizono*

396 397 398 399
*   Preserve column comment value on changing column name on MySQL.

    *Islam Taha*

400 401 402 403 404 405
*   Add support for `if_exists` option for removing an index.

    The `remove_index` method can take an `if_exists` option. If this is set to true an error won't be raised if the index doesn't exist.

    *Eileen M. Uchitelle*

406 407 408 409
*   Remove ibm_db, informix, mssql, oracle, and oracle12 Arel visitors which are not used in the code base.

    *Ryuta Kamizono*

410 411
*   Prevent `build_association` from `touching` a parent record if the record isn't persisted for `has_one` associations.

R
Ryuta Kamizono 已提交
412
    Fixes #38219.
413 414

    *Josh Brody*
415

416 417 418 419 420 421 422
*   Add support for `if_not_exists` option for adding index.

    The `add_index` method respects `if_not_exists` option. If it is set to true
    index won't be added.

    Usage:

R
Ryuta Kamizono 已提交
423
    ```ruby
424 425 426
      add_index :users, :account_id, if_not_exists: true
    ```

R
Ryuta Kamizono 已提交
427
    The `if_not_exists` option passed to `create_table` also gets propagated to indexes
428 429 430 431 432
    created within that migration so that if table and its indexes exist then there is no
    attempt to create them again.

    *Prathamesh Sonpatki*

433 434 435 436
*   Add `ActiveRecord::Base#previously_new_record?` to show if a record was new before the last save.

    *Tom Ward*

R
Ryuta Kamizono 已提交
437
*   Support descending order for `find_each`, `find_in_batches`, and `in_batches`.
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452

    Batch processing methods allow you to work with the records in batches, greatly reducing memory consumption, but records are always batched from oldest id to newest.

    This change allows reversing the order, batching from newest to oldest. This is useful when you need to process newer batches of records first.

    Pass `order: :desc` to yield batches in descending order. The default remains `order: :asc`.

    ```ruby
    Person.find_each(order: :desc) do |person|
      person.party_all_night!
    end
    ```

    *Alexey Vasiliev*

R
Ryuta Kamizono 已提交
453
*   Fix `insert_all` with enum values.
454 455 456 457

    Fixes #38716.

    *Joel Blum*
458

459 460 461 462 463 464
*   Add support for `db:rollback:name` for multiple database applications.

    Multiple database applications will now raise if `db:rollback` is call and recommend using the `db:rollback:[NAME]` to rollback migrations.

    *Eileen M. Uchitelle*

465 466 467 468
*   `Relation#pick` now uses already loaded results instead of making another query.

    *Eugene Kenny*

469
*   Deprecate using `return`, `break` or `throw` to exit a transaction block after writes.
470 471 472

    *Dylan Thacker-Smith*

473
*   Dump the schema or structure of a database when calling `db:migrate:name`.
474 475 476 477 478 479 480

    In previous versions of Rails, `rails db:migrate` would dump the schema of the database. In Rails 6, that holds true (`rails db:migrate` dumps all databases' schemas), but `rails db:migrate:name` does not share that behavior.

    Going forward, calls to `rails db:migrate:name` will dump the schema (or structure) of the database being migrated.

    *Kyle Thompson*

481
*   Reset the `ActiveRecord::Base` connection after `rails db:migrate:name`.
482 483 484 485 486

    When `rails db:migrate` has finished, it ensures the `ActiveRecord::Base` connection is reset to its original configuration. Going forward, `rails db:migrate:name` will have the same behavior.

    *Kyle Thompson*

487 488 489 490 491 492
*   Disallow calling `connected_to` on subclasses of `ActiveRecord::Base`.

    Behavior has not changed here but the previous API could be misleading to people who thought it would switch connections for only that class. `connected_to` switches the context from which we are getting connections, not the connections themselves.

    *Eileen M. Uchitelle*, *John Crepezzi*

493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
*   Add support for horizontal sharding to `connects_to` and `connected_to`.

    Applications can now connect to multiple shards and switch between their shards in an application. Note that the shard swapping is still a manual process as this change does not include an API for automatic shard swapping.

    Usage:

    Given the following configuration:

    ```yaml
    # config/database.yml
    production:
      primary:
        database: my_database
      primary_shard_one:
        database: my_database_shard_one
    ```

    Connect to multiple shards:

    ```ruby
    class ApplicationRecord < ActiveRecord::Base
      self.abstract_class = true

      connects_to shards: {
        default: { writing: :primary },
        shard_one: { writing: :primary_shard_one }
      }
    ```

    Swap between shards in your controller / model code:

    ```ruby
    ActiveRecord::Base.connected_to(shard: :shard_one) do
      # Read from shard one
    end
    ```

    The horizontal sharding API also supports read replicas. See guides for more details.

    *Eileen M. Uchitelle*, *John Crepezzi*
R
Ryuta Kamizono 已提交
533 534

*   Deprecate `spec_name` in favor of `name` on database configurations.
535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553

    The accessors for `spec_name` on `configs_for` and `DatabaseConfig` are deprecated. Please use `name` instead.

    Deprecated behavior:

    ```ruby
    db_config = ActiveRecord::Base.configs_for(env_name: "development", spec_name: "primary")
    db_config.spec_name
    ```

    New behavior:

    ```ruby
    db_config = ActiveRecord::Base.configs_for(env_name: "development", name: "primary")
    db_config.name
    ```

    *Eileen M. Uchitelle*

R
Ryuta Kamizono 已提交
554
*   Add additional database-specific rake tasks for multi-database users.
555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593

    Previously, `rails db:create`, `rails db:drop`, and `rails db:migrate` were the only rails tasks that could operate on a single
    database. For example:

    ```
    rails db:create
    rails db:create:primary
    rails db:create:animals
    rails db:drop
    rails db:drop:primary
    rails db:drop:animals
    rails db:migrate
    rails db:migrate:primary
    rails db:migrate:animals
    ```

    With these changes, `rails db:schema:dump`, `rails db:schema:load`, `rails db:structure:dump`, `rails db:structure:load` and
    `rails db:test:prepare` can additionally operate on a single database. For example:

    ```
    rails db:schema:dump
    rails db:schema:dump:primary
    rails db:schema:dump:animals
    rails db:schema:load
    rails db:schema:load:primary
    rails db:schema:load:animals
    rails db:structure:dump
    rails db:structure:dump:primary
    rails db:structure:dump:animals
    rails db:structure:load
    rails db:structure:load:primary
    rails db:structure:load:animals
    rails db:test:prepare
    rails db:test:prepare:primary
    rails db:test:prepare:animals
    ```

    *Kyle Thompson*

594 595 596 597 598 599
*   Add support for `strict_loading` mode on association declarations.

    Raise an error if attempting to load a record from an association that has been marked as `strict_loading` unless it was explicitly eager loaded.

    Usage:

R
Ryuta Kamizono 已提交
600 601 602 603 604 605 606 607
    ```ruby
    class Developer < ApplicationRecord
      has_many :projects, strict_loading: true
    end

    dev = Developer.first
    dev.projects.first
    # => ActiveRecord::StrictLoadingViolationError: The projects association is marked as strict_loading and cannot be lazily loaded.
608 609 610 611
    ```

    *Kevin Deisz*

612 613 614 615 616 617
*   Add support for `strict_loading` mode to prevent lazy loading of records.

    Raise an error if a parent record is marked as `strict_loading` and attempts to lazily load its associations. This is useful for finding places you may want to preload an association and avoid additional queries.

    Usage:

R
Ryuta Kamizono 已提交
618 619 620 621
    ```ruby
    dev = Developer.strict_loading.first
    dev.audit_logs.to_a
    # => ActiveRecord::StrictLoadingViolationError: Developer is marked as strict_loading and AuditLog cannot be lazily loaded.
622 623 624 625
    ```

    *Eileen M. Uchitelle*, *Aaron Patterson*

626 627 628 629
*   Add support for PostgreSQL 11+ partitioned indexes when using `upsert_all`.

    *Sebastián Palma*

630
*   Adds support for `if_not_exists` to `add_column` and `if_exists` to `remove_column`.
631 632 633 634 635

    Applications can set their migrations to ignore exceptions raised when adding a column that already exists or when removing a column that does not exist.

    Example Usage:

R
Ryuta Kamizono 已提交
636
    ```ruby
637 638 639 640 641 642 643
    class AddColumnTitle < ActiveRecord::Migration[6.1]
      def change
        add_column :posts, :title, :string, if_not_exists: true
      end
    end
    ```

R
Ryuta Kamizono 已提交
644
    ```ruby
645 646 647 648 649 650 651 652 653
    class RemoveColumnTitle < ActiveRecord::Migration[6.1]
      def change
        remove_column :posts, :title, if_exists: true
      end
    end
    ```

    *Eileen M. Uchitelle*

R
Ryuta Kamizono 已提交
654
*   Regexp-escape table name for MS SQL Server.
L
Larry Reid 已提交
655 656 657 658 659

    Add `Regexp.escape` to one method in ActiveRecord, so that table names with regular expression characters in them work as expected. Since MS SQL Server uses "[" and "]" to quote table and column names, and those characters are regular expression characters, methods like `pluck` and `select` fail in certain cases when used with the MS SQL Server adapter.

    *Larry Reid*

660 661 662 663
*   Store advisory locks on their own named connection.

    Previously advisory locks were taken out against a connection when a migration started. This works fine in single database applications but doesn't work well when migrations need to open new connections which results in the lock getting dropped.

664
    In order to fix this we are storing the advisory lock on a new connection with the connection specification name `AdvisoryLockBase`. The caveat is that we need to maintain at least 2 connections to a database while migrations are running in order to do this.
665 666 667

    *Eileen M. Uchitelle*, *John Crepezzi*

668 669 670 671
*   Allow schema cache path to be defined in the database configuration file.

    For example:

R
Ryuta Kamizono 已提交
672
    ```yaml
673 674 675 676 677 678 679 680 681
    development:
      adapter: postgresql
      database: blog_development
      pool: 5
      schema_cache_path: tmp/schema/main.yml
    ```

    *Katrina Owen*

682 683 684 685 686 687
*   Deprecate `#remove_connection` in favor of `#remove_connection_pool` when called on the handler.

    `#remove_connection` is deprecated in order to support returning a `DatabaseConfig` object instead of a `Hash`. Use `#remove_connection_pool`, `#remove_connection` will be removed in 6.2.

    *Eileen M. Uchitelle*, *John Crepezzi*

R
Ryuta Kamizono 已提交
688
*   Deprecate `#default_hash` and it's alias `#[]` on database configurations.
689 690

    Applications should use `configs_for`. `#default_hash` and `#[]` will be removed in 6.2.
691 692

    *Eileen M. Uchitelle*, *John Crepezzi*
693

694 695 696 697
*   Add scale support to `ActiveRecord::Validations::NumericalityValidator`.

    *Gannon McGibbon*

698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713
*   Find orphans by looking for missing relations through chaining `where.missing`:

    Before:

    ```ruby
    Post.left_joins(:author).where(authors: { id: nil })
    ```

    After:

    ```ruby
    Post.where.missing(:author)
    ```

    *Tom Rossi*

714 715 716 717 718 719
*   Ensure `:reading` connections always raise if a write is attempted.

    Now Rails will raise an `ActiveRecord::ReadOnlyError` if any connection on the reading handler attempts to make a write. If your reading role needs to write you should name the role something other than `:reading`.

    *Eileen M. Uchitelle*

R
Ryuta Kamizono 已提交
720
*   Deprecate `"primary"` as the `connection_specification_name` for `ActiveRecord::Base`.
721 722 723 724 725

    `"primary"` has been deprecated as the `connection_specification_name` for `ActiveRecord::Base` in favor of using `"ActiveRecord::Base"`. This change affects calls to `ActiveRecord::Base.connection_handler.retrieve_connection` and `ActiveRecord::Base.connection_handler.remove_connection`. If you're calling these methods with `"primary"`, please switch to `"ActiveRecord::Base"`.

    *Eileen M. Uchitelle*, *John Crepezzi*

726 727 728 729 730
*   Add `ActiveRecord::Validations::NumericalityValidator` with
    support for casting floats using a database columns' precision value.

    *Gannon McGibbon*

731 732 733 734
*   Enforce fresh ETag header after a collection's contents change by adding
    ActiveRecord::Relation#cache_key_with_version. This method will be used by
    ActionController::ConditionalGet to ensure that when collection cache versioning
    is enabled, requests using ConditionalGet don't return the same ETag header
R
Ryuta Kamizono 已提交
735 736 737
    after a collection is modified.

    Fixes #38078.
738 739 740

    *Aaron Lipman*

741 742 743 744 745
*   Skip test database when running `db:create` or `db:drop` in development
    with `DATABASE_URL` set.

    *Brian Buchalter*

746
*   Don't allow mutations on the database configurations hash.
E
eileencodes 已提交
747

748
    Freeze the configurations hash to disallow directly changing it. If applications need to change the hash, for example to create databases for parallelization, they should use the `DatabaseConfig` object directly.
E
eileencodes 已提交
749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766

    Before:

    ```ruby
    @db_config = ActiveRecord::Base.configurations.configs_for(env_name: "test", spec_name: "primary")
    @db_config.configuration_hash.merge!(idle_timeout: "0.02")
    ```

    After:

    ```ruby
    @db_config = ActiveRecord::Base.configurations.configs_for(env_name: "test", spec_name: "primary")
    config = @db_config.configuration_hash.merge(idle_timeout: "0.02")
    db_config = ActiveRecord::DatabaseConfigurations::HashConfig.new(@db_config.env_name, @db_config.spec_name, config)
    ```

    *Eileen M. Uchitelle*, *John Crepezzi*

767 768 769 770
*   Remove `:connection_id` from the `sql.active_record` notification.

    *Aaron Patterson*, *Rafael Mendonça França*

771 772 773 774
*   The `:name` key will no longer be returned as part of `DatabaseConfig#configuration_hash`. Please use `DatabaseConfig#owner_name` instead.

    *Eileen M. Uchitelle*, *John Crepezzi*

775 776 777 778
*   ActiveRecord's `belongs_to_required_by_default` flag can now be set per model.

    You can now opt-out/opt-in specific models from having their associations required
    by default.
779

780 781 782 783 784
    This change is meant to ease the process of migrating all your models to have
    their association required.

    *Edouard Chin*

J
John Crepezzi 已提交
785 786 787 788
*   The `connection_config` method has been deprecated, please use `connection_db_config` instead which will return a `DatabaseConfigurations::DatabaseConfig` instead of a `Hash`.

    *Eileen M. Uchitelle*, *John Crepezzi*

789 790 791 792 793 794
*   Retain explicit selections on the base model after applying `includes` and `joins`.

    Resolves #34889.

    *Patrick Rebsch*

795 796 797 798
*   The `database` kwarg is deprecated without replacement because it can't be used for sharding and creates an issue if it's used during a request. Applications that need to create new connections should use `connects_to` instead.

    *Eileen M. Uchitelle*, *John Crepezzi*

G
Gannon McGibbon 已提交
799 800 801 802
*   Allow attributes to be fetched from Arel node groupings.

    *Jeff Emminger*, *Gannon McGibbon*

R
Ryuta Kamizono 已提交
803
*   A database URL can now contain a querystring value that contains an equal sign. This is needed to support passing PostgreSQL `options`.
804 805 806

    *Joshua Flanagan*

807 808 809 810
*   Calling methods like `establish_connection` with a `Hash` which is invalid (eg: no `adapter`) will now raise an error the same way as connections defined in `config/database.yml`.

    *John Crepezzi*

811 812 813 814
*   Specifying `implicit_order_column` now subsorts the records by primary key if available to ensure deterministic results.

    *Paweł Urbanek*

J
John Hawthorn 已提交
815 816 817 818
*   `where(attr => [])` now loads an empty result without making a query.

    *John Hawthorn*

819 820 821 822
*   Fixed the performance regression for `primary_keys` introduced MySQL 8.0.

    *Hiroyuki Ishii*

823 824 825 826
*   Add support for `belongs_to` to `has_many` inversing.

    *Gannon McGibbon*

827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845
*   Allow length configuration for `has_secure_token` method. The minimum length
    is set at 24 characters.

    Before:

    ```ruby
    has_secure_token :auth_token
    ```

    After:

    ```ruby
    has_secure_token :default_token             # 24 characters
    has_secure_token :auth_token, length: 36    # 36 characters
    has_secure_token :invalid_token, length: 12 # => ActiveRecord::SecureToken::MinimumLengthError
    ```

    *Bernardo de Araujo*

846 847 848 849
*   Deprecate `DatabaseConfigurations#to_h`. These connection hashes are still available via `ActiveRecord::Base.configurations.configs_for`.

    *Eileen Uchitelle*, *John Crepezzi*

850 851 852 853
*   Add `DatabaseConfig#configuration_hash` to return database configuration hashes with symbol keys, and use all symbol-key configuration hashes internally. Deprecate `DatabaseConfig#config` which returns a String-keyed `Hash` with the same values.

    *John Crepezzi*, *Eileen Uchitelle*

854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870
*   Allow column names to be passed to `remove_index` positionally along with other options.

    Passing other options can be necessary to make `remove_index` correctly reversible.

    Before:

        add_index    :reports, :report_id               # => works
        add_index    :reports, :report_id, unique: true # => works
        remove_index :reports, :report_id               # => works
        remove_index :reports, :report_id, unique: true # => ArgumentError

    After:

        remove_index :reports, :report_id, unique: true # => works

    *Eugene Kenny*

871 872 873 874
*   Allow bulk `ALTER` statements to drop and recreate indexes with the same name.

    *Eugene Kenny*

875 876 877 878
*   `insert`, `insert_all`, `upsert`, and `upsert_all` now clear the query cache.

    *Eugene Kenny*

879
*   Call `while_preventing_writes` directly from `connected_to`.
880

881
    In some cases application authors want to use the database switching middleware and make explicit calls with `connected_to`. It's possible for an app to turn off writes and not turn them back on by the time we call `connected_to(role: :writing)`.
882 883 884 885 886

    This change allows apps to fix this by assuming if a role is writing we want to allow writes, except in the case it's explicitly turned off.

    *Eileen M. Uchitelle*

887 888 889 890
*   Improve detection of ActiveRecord::StatementTimeout with mysql2 adapter in the edge case when the query is terminated during filesort.

    *Kir Shatrov*

891 892 893 894
*   Stop trying to read yaml file fixtures when loading Active Record fixtures.

    *Gannon McGibbon*

895 896 897 898 899 900
*   Deprecate `.reorder(nil)` with `.first` / `.first!` taking non-deterministic result.

    To continue taking non-deterministic result, use `.take` / `.take!` instead.

    *Ryuta Kamizono*

901 902 903 904
*   Ensure custom PK types are casted in through reflection queries.

    *Gannon McGibbon*

905 906 907 908 909 910
*   Preserve user supplied joins order as much as possible.

    Fixes #36761, #34328, #24281, #12953.

    *Ryuta Kamizono*

911
*   Allow `matches_regex` and `does_not_match_regexp` on the MySQL Arel visitor.
J
James Pearson 已提交
912 913

    *James Pearson*
914

915 916 917 918
*   Allow specifying fixtures to be ignored by setting `ignore` in YAML file's '_fixture' section.

    *Tongfei Gao*

919 920 921 922
*   Make the DATABASE_URL env variable only affect the primary connection. Add new env variables for multiple databases.

    *John Crepezzi*, *Eileen Uchitelle*

923 924 925 926 927 928 929 930
*   Add a warning for enum elements with 'not_' prefix.

        class Foo
          enum status: [:sent, :not_sent]
        end

    *Edu Depetris*

R
Ryuta Kamizono 已提交
931
*   Make currency symbols optional for money column type in PostgreSQL.
932 933 934

    *Joel Schneider*

935 936 937 938
*   Add support for beginless ranges, introduced in Ruby 2.7.

    *Josh Goodall*

R
Ryuta Kamizono 已提交
939
*   Add `database_exists?` method to connection adapters to check if a database exists.
940

R
Roberto Miranda 已提交
941
    *Guilherme Mansur*
942

943 944 945 946
*   Loading the schema for a model that has no `table_name` raises a `TableNotSpecified` error.

    *Guilherme Mansur*, *Eugene Kenny*

947 948 949 950 951 952
*   PostgreSQL: Fix GROUP BY with ORDER BY virtual count attribute.

    Fixes #36022.

    *Ryuta Kamizono*

953 954 955 956 957 958
*   Make ActiveRecord `ConnectionPool.connections` method thread-safe.

    Fixes #36465.

    *Jeff Doering*

959 960 961 962
*   Add support for multiple databases to `rails db:abort_if_pending_migrations`.

    *Mark Lee*

963 964 965 966
*   Fix sqlite3 collation parsing when using decimal columns.

    *Martin R. Schuster*

967
*   Fix invalid schema when primary key column has a comment.
968

969
    Fixes #29966.
970 971 972

    *Guilherme Goettems Schneider*

973
*   Fix table comment also being applied to the primary key column.
974 975 976

    *Guilherme Goettems Schneider*

977
*   Allow generated `create_table` migrations to include or skip timestamps.
978

979
    *Michael Duchemin*
980

981

982
Please check [6-0-stable](https://github.com/rails/rails/blob/6-0-stable/activerecord/CHANGELOG.md) for previous changes.