Merge pull request rails#49116 from gmcgibbon/where_tuple_docs

eileencodes · web-flow · commit ad83a66b70cb · 2023-09-05T11:31:54.000-04:00
Document tuple support in Active Record where clauses
diff --git a/activerecord/lib/active_record/relation/query_methods.rb b/activerecord/lib/active_record/relation/query_methods.rb
@@ -883,6 +883,12 @@ def left_outer_joins!(*args) # :nodoc:
     #    PriceEstimate.where(estimate_of: treasure)
     #    PriceEstimate.where(estimate_of_type: 'Treasure', estimate_of_id: treasure)
     #
+    # Hash conditions may also be specified in a tuple-like syntax. Hash keys may be
+    # an array of columns with an array of tuples as values.
+    #
+    #   Article.where([:author_id, :id] => [[15, 1], [15, 2]])
+    #   # SELECT * FROM articles WHERE author_id = 15 AND id = 1 OR author_id = 15 AND id = 2
+    #
     # === Joins
     #
     # If the relation is the result of a join, you may create a condition which uses any of the

Original file line number	Diff line number	Diff line change
`@@ -883,6 +883,12 @@ def left_outer_joins!(*args) # :nodoc:`
`883`	`883`	`# PriceEstimate.where(estimate_of: treasure)`
`884`	`884`	`# PriceEstimate.where(estimate_of_type: 'Treasure', estimate_of_id: treasure)`
`885`	`885`	`#`
	`886`	`+ # Hash conditions may also be specified in a tuple-like syntax. Hash keys may be`
	`887`	`+ # an array of columns with an array of tuples as values.`
	`888`	`+ #`
	`889`	`+ # Article.where([:author_id, :id] => [[15, 1], [15, 2]])`
	`890`	`+ # # SELECT * FROM articles WHERE author_id = 15 AND id = 1 OR author_id = 15 AND id = 2`
	`891`	`+ #`
`886`	`892`	`# === Joins`
`887`	`893`	`#`
`888`	`894`	`# If the relation is the result of a join, you may create a condition which uses any of the`