aboutsummaryrefslogtreecommitdiffstats
path: root/activerecord/lib/active_record/relation/batches.rb
diff options
context:
space:
mode:
authorIsaac Seymour <isaac@gocardless.com>2014-12-03 21:56:14 +0000
committerIsaac Seymour <isaac@gocardless.com>2014-12-03 21:56:14 +0000
commitdb64f5d7ebef9834dcfe8476c3e8941cd9ce598c (patch)
tree0ed2e557b8625ae9371953fd3eee9e1c87437598 /activerecord/lib/active_record/relation/batches.rb
parenta83ad97f473a684417dc22fd7854ee5526e1b8ca (diff)
downloadrails-db64f5d7ebef9834dcfe8476c3e8941cd9ce598c.tar.gz
rails-db64f5d7ebef9834dcfe8476c3e8941cd9ce598c.tar.bz2
rails-db64f5d7ebef9834dcfe8476c3e8941cd9ce598c.zip
Clarify that batching methods can be used with any orderable type primary key, not just integer ones, as per @a58cafeb3a86be46849de57481b6644094fb8165
Diffstat (limited to 'activerecord/lib/active_record/relation/batches.rb')
-rw-r--r--activerecord/lib/active_record/relation/batches.rb8
1 files changed, 4 insertions, 4 deletions
diff --git a/activerecord/lib/active_record/relation/batches.rb b/activerecord/lib/active_record/relation/batches.rb
index b069cdce7c..20d24b409b 100644
--- a/activerecord/lib/active_record/relation/batches.rb
+++ b/activerecord/lib/active_record/relation/batches.rb
@@ -40,8 +40,8 @@ module ActiveRecord
#
# NOTE: It's not possible to set the order. That is automatically set to
# ascending on the primary key ("id ASC") to make the batch ordering
- # work. This also means that this method only works with integer-based
- # primary keys.
+ # work. This also means that this method only works when the primary key is
+ # orderable (e.g. an integer or string).
#
# NOTE: You can't set the limit either, that's used to control
# the batch sizes.
@@ -90,8 +90,8 @@ module ActiveRecord
#
# NOTE: It's not possible to set the order. That is automatically set to
# ascending on the primary key ("id ASC") to make the batch ordering
- # work. This also means that this method only works with integer-based
- # primary keys.
+ # work. This also means that this method only works when the primary key is
+ # orderable (e.g. an integer or string).
#
# NOTE: You can't set the limit either, that's used to control
# the batch sizes.