From d62645cfbf53e43eae7ce0cba3781e58bb7a894a Mon Sep 17 00:00:00 2001 From: Florent Guilleux Date: Sat, 16 Jun 2012 17:16:10 -0500 Subject: Add documentation for ActiveRecord::QueryMethods#limit [ci skip] --- activerecord/lib/active_record/relation/query_methods.rb | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) (limited to 'activerecord/lib/active_record/relation') diff --git a/activerecord/lib/active_record/relation/query_methods.rb b/activerecord/lib/active_record/relation/query_methods.rb index a89d0f3ebf..1fb4cbe1c4 100644 --- a/activerecord/lib/active_record/relation/query_methods.rb +++ b/activerecord/lib/active_record/relation/query_methods.rb @@ -71,8 +71,6 @@ module ActiveRecord # Used to indicate that an association is referenced by an SQL string, and should # therefore be JOINed in any query rather than loaded separately. # - # For example: - # # User.includes(:posts).where("posts.name = 'foo'") # # => Doesn't JOIN the posts table, resulting in an error. # @@ -163,7 +161,6 @@ module ActiveRecord # User.order('email DESC').reorder('id ASC').order('name ASC') # # generates a query with 'ORDER BY id ASC, name ASC'. - # def reorder(*args) args.blank? ? self : spawn.reorder!(*args) end @@ -216,6 +213,13 @@ module ActiveRecord self end + # Specifies a limit of records. + # + # User.limit(10) # generated SQL has 'LIMIT 10' + # + # Replaces any existing previous limit. + # + # User.limit(10).limit(20) # generated SQL has 'LIMIT 20' def limit(value) spawn.limit!(value) end -- cgit v1.2.3 From a28eda16d34e2b85c5f0afeaa3a40410043a0605 Mon Sep 17 00:00:00 2001 From: Ulises Cabanillas Date: Sat, 16 Jun 2012 17:32:10 -0500 Subject: Add documentation for ActiveRecord::QueryMethods#offset [ci skip] --- activerecord/lib/active_record/relation/query_methods.rb | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'activerecord/lib/active_record/relation') diff --git a/activerecord/lib/active_record/relation/query_methods.rb b/activerecord/lib/active_record/relation/query_methods.rb index 1fb4cbe1c4..250c1f8769 100644 --- a/activerecord/lib/active_record/relation/query_methods.rb +++ b/activerecord/lib/active_record/relation/query_methods.rb @@ -229,6 +229,13 @@ module ActiveRecord self end + # Specifies the number of rows to skip before returning rows. + # + # User.offset(10) # generated SQL has "OFFSET 10" + # + # Should be used with order. + # + # User.offset(10).order("name ASC") def offset(value) spawn.offset!(value) end -- cgit v1.2.3 From 7ed38907fd9e8a4f4a3fe9b33b1902acfafaef24 Mon Sep 17 00:00:00 2001 From: Florent Guilleux Date: Sat, 16 Jun 2012 17:41:43 -0500 Subject: Add documentation for ActiveRecord::QueryMethods#reverse_order [ci skip] --- activerecord/lib/active_record/relation/query_methods.rb | 3 +++ 1 file changed, 3 insertions(+) (limited to 'activerecord/lib/active_record/relation') diff --git a/activerecord/lib/active_record/relation/query_methods.rb b/activerecord/lib/active_record/relation/query_methods.rb index 250c1f8769..08803552ff 100644 --- a/activerecord/lib/active_record/relation/query_methods.rb +++ b/activerecord/lib/active_record/relation/query_methods.rb @@ -405,6 +405,9 @@ module ActiveRecord self end + # Reverse the existing order clause on the relation. + # + # User.order('name ASC').reverse_order # generated SQL has 'ORDER BY name DESC' def reverse_order spawn.reverse_order! end -- cgit v1.2.3 From 6285675db1cf983ba6c15442aedb457c8041f5ee Mon Sep 17 00:00:00 2001 From: Vijay Dev Date: Fri, 22 Jun 2012 22:14:29 +0530 Subject: fixes a few mistakes in api docs [ci skip] --- activerecord/lib/active_record/relation/query_methods.rb | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) (limited to 'activerecord/lib/active_record/relation') diff --git a/activerecord/lib/active_record/relation/query_methods.rb b/activerecord/lib/active_record/relation/query_methods.rb index 08803552ff..6fa64b39c3 100644 --- a/activerecord/lib/active_record/relation/query_methods.rb +++ b/activerecord/lib/active_record/relation/query_methods.rb @@ -213,12 +213,10 @@ module ActiveRecord self end - # Specifies a limit of records. + # Specifies a limit for the number of records to retrieve. # # User.limit(10) # generated SQL has 'LIMIT 10' # - # Replaces any existing previous limit. - # # User.limit(10).limit(20) # generated SQL has 'LIMIT 20' def limit(value) spawn.limit!(value) @@ -233,7 +231,7 @@ module ActiveRecord # # User.offset(10) # generated SQL has "OFFSET 10" # - # Should be used with order. + # Should be used with order. # # User.offset(10).order("name ASC") def offset(value) -- cgit v1.2.3