跳至內容 跳至搜尋
方法
E
F
I
L
M
S
T

常數

ONE_AS_ONE = "1 AS one"
 

實例公開方法

exists?(conditions = :none)

如果資料表中存在與給定的 id 或條件相符的記錄,則傳回 true,否則傳回 false。參數可以有六種形式

  • Integer - 找出具有此主鍵的記錄。

  • String - 找出主鍵對應到此字串的記錄(例如 '5')。

  • Array - 找出符合這些 where 樣式條件的記錄(例如 ['name LIKE ?', "%#{query}%"])。

  • Hash - 找出符合這些 where 樣式條件的記錄(例如 {name: 'David'})。

  • false - 永遠傳回 false

  • 沒有參數 - 如果關係為空,則傳回 false,否則傳回 true

有關將條件指定為雜湊或陣列的詳細資訊,請參閱 ActiveRecord::Base 簡介中的條件部分。

注意:您無法傳入字串條件(例如 name = 'Jamie'),因為它會被清除,然後針對主鍵欄位進行查詢,例如 id = 'name = \'Jamie\''

Person.exists?(5)
Person.exists?('5')
Person.exists?(['name LIKE ?', "%#{query}%"])
Person.exists?(id: [1, 4, 8])
Person.exists?(name: 'David')
Person.exists?(false)
Person.exists?
Person.where(name: 'Spartacus', rating: 4).exists?
# File activerecord/lib/active_record/relation/finder_methods.rb, line 349
    def exists?(conditions = :none)
      return false if @none

      if Base === conditions
        raise ArgumentError, <<-MSG.squish
          You are passing an instance of ActiveRecord::Base to `exists?`.
          Please pass the id of the object by calling `.id`.
        MSG
      end

      return false if !conditions || limit_value == 0

      if eager_loading?
        relation = apply_join_dependency(eager_loading: false)
        return relation.exists?(conditions)
      end

      relation = construct_relation_for_exists(conditions)
      return false if relation.where_clause.contradiction?

      skip_query_cache_if_necessary { connection.select_rows(relation.arel, "#{name} Exists?").size == 1 }
    end

fifth()

找出第五筆記錄。如果沒有定義順序,它將按主鍵排序。

Person.fifth # returns the fifth object fetched by SELECT * FROM people
Person.offset(3).fifth # returns the fifth object from OFFSET 3 (which is OFFSET 7)
Person.where(["user_name = :u", { u: user_name }]).fifth
# File activerecord/lib/active_record/relation/finder_methods.rb, line 263
def fifth
  find_nth 4
end

fifth!()

fifth 相同,但如果找不到記錄,會引發 ActiveRecord::RecordNotFound

# File activerecord/lib/active_record/relation/finder_methods.rb, line 269
def fifth!
  fifth || raise_record_not_found_exception!
end

find(*args)

依 ID 尋找 - 這可以是特定 ID (ID)、ID 清單 (ID、ID、ID) 或 ID 陣列 ([ID、ID、ID])。`ID` 指的是「識別碼」。對於具有單一欄位主鍵的模型,`ID` 會是單一值,而對於具有複合主鍵的模型,它會是值陣列。如果無法針對請求的 ID 找到一個或多個記錄,則會引發 ActiveRecord::RecordNotFound。如果主鍵是整數,`find` 會使用 `to_i` 轉換其參數。

Person.find(1)          # returns the object for ID = 1
Person.find("1")        # returns the object for ID = 1
Person.find("31-sarah") # returns the object for ID = 31
Person.find(1, 2, 6)    # returns an array for objects with IDs in (1, 2, 6)
Person.find([7, 17])    # returns an array for objects with IDs in (7, 17), or with composite primary key [7, 17]
Person.find([1])        # returns an array for the object with ID = 1
Person.where("administrator = 1").order("created_on DESC").find(1)

尋找複合主鍵模型的記錄

TravelRoute.primary_key = [:origin, :destination]

TravelRoute.find(["Ottawa", "London"])
=> #<TravelRoute origin: "Ottawa", destination: "London">

TravelRoute.find([["Paris", "Montreal"]])
=> [#<TravelRoute origin: "Paris", destination: "Montreal">]

TravelRoute.find(["New York", "Las Vegas"], ["New York", "Portland"])
=> [
     #<TravelRoute origin: "New York", destination: "Las Vegas">,
     #<TravelRoute origin: "New York", destination: "Portland">
   ]

TravelRoute.find([["Berlin", "London"], ["Barcelona", "Lisbon"]])
=> [
     #<TravelRoute origin: "Berlin", destination: "London">,
     #<TravelRoute origin: "Barcelona", destination: "Lisbon">
   ]

注意:傳回的記錄與您提供的 ID 順序相同。如果您希望結果由資料庫排序,可以使用 ActiveRecord::QueryMethods#where 方法,並提供明確的 ActiveRecord::QueryMethods#order 選項。但 ActiveRecord::QueryMethods#where 方法不會引發 ActiveRecord::RecordNotFound

使用鎖定尋找

使用鎖定尋找的範例:想像兩個並發交易:每個交易都會讀取 person.visits == 2,將其加 1,並儲存,導致 person.visits = 3 儲存兩次。透過鎖定列,第二個交易必須等到第一個交易完成;我們會得到預期的 person.visits == 4

Person.transaction do
  person = Person.lock(true).find(1)
  person.visits += 1
  person.save!
end

find 的變異

Person.where(name: 'Spartacus', rating: 4)
# returns a chainable list (which can be empty).

Person.find_by(name: 'Spartacus', rating: 4)
# returns the first item or nil.

Person.find_or_initialize_by(name: 'Spartacus', rating: 4)
# returns the first item or returns a new instance (requires you call .save to persist against the database).

Person.find_or_create_by(name: 'Spartacus', rating: 4)
# returns the first item or creates it and returns it.

find 的替代方案

Person.where(name: 'Spartacus', rating: 4).exists?(conditions = :none)
# returns a boolean indicating if any record with the given conditions exist.

Person.where(name: 'Spartacus', rating: 4).select("field1, field2, field3")
# returns a chainable list of instances with only the mentioned fields.

Person.where(name: 'Spartacus', rating: 4).ids
# returns an Array of ids.

Person.where(name: 'Spartacus', rating: 4).pluck(:field1, :field2)
# returns an Array of the required fields.
# File activerecord/lib/active_record/relation/finder_methods.rb, line 90
def find(*args)
  return super if block_given?
  find_with_ids(*args)
end

find_by(arg, *args)

找出符合指定條件的第一筆記錄。此方法沒有隱含的排序,因此如果排序很重要,您應該自行指定。

如果找不到任何記錄,則傳回 nil

Post.find_by name: 'Spartacus', rating: 4
Post.find_by "published_at < ?", 2.weeks.ago
# File activerecord/lib/active_record/relation/finder_methods.rb, line 103
def find_by(arg, *args)
  where(arg, *args).take
end

find_by!(arg, *args)

find_by 相同,但如果找不到任何記錄,則會引發 ActiveRecord::RecordNotFound 錯誤。

# File activerecord/lib/active_record/relation/finder_methods.rb, line 109
def find_by!(arg, *args)
  where(arg, *args).take!
end

find_sole_by(arg, *args)

找出符合條件的唯一記錄。如果找不到任何記錄,則引發 ActiveRecord::RecordNotFound。如果找到多於一筆記錄,則引發 ActiveRecord::SoleRecordExceeded

Product.find_sole_by(["price = %?", price])
# File activerecord/lib/active_record/relation/finder_methods.rb, line 152
def find_sole_by(arg, *args)
  where(arg, *args).sole
end

first(limit = nil)

找出第一筆記錄(如果提供參數,則找出前 N 筆記錄)。如果沒有定義排序,則會依據主鍵排序。

Person.first # returns the first object fetched by SELECT * FROM people ORDER BY people.id LIMIT 1
Person.where(["user_name = ?", user_name]).first
Person.where(["user_name = :u", { u: user_name }]).first
Person.order("created_on DESC").offset(5).first
Person.first(3) # returns the first three objects fetched by SELECT * FROM people ORDER BY people.id LIMIT 3
# File activerecord/lib/active_record/relation/finder_methods.rb, line 165
def first(limit = nil)
  if limit
    find_nth_with_limit(0, limit)
  else
    find_nth 0
  end
end

first!()

first 相同,但如果找不到記錄,會引發 ActiveRecord::RecordNotFound。請注意,first! 不接受任何參數。

# File activerecord/lib/active_record/relation/finder_methods.rb, line 175
def first!
  first || raise_record_not_found_exception!
end

forty_two()

尋找第 42 筆記錄。又稱為存取「reddit」。如果沒有定義順序,它將按主鍵排序。

Person.forty_two # returns the forty-second object fetched by SELECT * FROM people
Person.offset(3).forty_two # returns the forty-second object from OFFSET 3 (which is OFFSET 44)
Person.where(["user_name = :u", { u: user_name }]).forty_two
# File activerecord/lib/active_record/relation/finder_methods.rb, line 279
def forty_two
  find_nth 41
end

forty_two!()

forty_two 相同,但如果找不到記錄,會引發 ActiveRecord::RecordNotFound

# File activerecord/lib/active_record/relation/finder_methods.rb, line 285
def forty_two!
  forty_two || raise_record_not_found_exception!
end

fourth()

尋找第 4 筆記錄。如果沒有定義順序,它將按主鍵排序。

Person.fourth # returns the fourth object fetched by SELECT * FROM people
Person.offset(3).fourth # returns the fourth object from OFFSET 3 (which is OFFSET 6)
Person.where(["user_name = :u", { u: user_name }]).fourth
# File activerecord/lib/active_record/relation/finder_methods.rb, line 247
def fourth
  find_nth 3
end

fourth!()

fourth 相同,但如果找不到記錄,會引發 ActiveRecord::RecordNotFound

# File activerecord/lib/active_record/relation/finder_methods.rb, line 253
def fourth!
  fourth || raise_record_not_found_exception!
end

include?(record)

如果關係包含給定的記錄,則傳回 true,否則傳回 false。

如果關聯載入,不會執行任何查詢;會將給定的記錄與記憶體中的記錄進行比較。如果關聯卸載,會執行有效的存在查詢,如 exists?

別名:member?
# File activerecord/lib/active_record/relation/finder_methods.rb, line 377
def include?(record)
  # The existing implementation relies on receiving an Active Record instance as the input parameter named record.
  # Any non-Active Record object passed to this implementation is guaranteed to return `false`.
  return false unless record.is_a?(klass)

  if loaded? || offset_value || limit_value || having_clause.any?
    records.include?(record)
  else
    id = if record.class.composite_primary_key?
      record.class.primary_key.zip(record.id).to_h
    else
      record.id
    end

    exists?(id)
  end
end

last(limit = nil)

尋找最後一筆記錄(如果提供參數,則尋找最後 N 筆記錄)。如果未定義順序,它將按主鍵排序。

Person.last # returns the last object fetched by SELECT * FROM people
Person.where(["user_name = ?", user_name]).last
Person.order("created_on DESC").offset(5).last
Person.last(3) # returns the last three objects fetched by SELECT * FROM people.

請注意,在最後一個案例中,結果會按遞增順序排序

[#<Person id:2>, #<Person id:3>, #<Person id:4>]

而不是

[#<Person id:4>, #<Person id:3>, #<Person id:2>]
# File activerecord/lib/active_record/relation/finder_methods.rb, line 194
def last(limit = nil)
  return find_last(limit) if loaded? || has_limit_or_offset?

  result = ordered_relation.limit(limit)
  result = result.reverse_order!

  limit ? result.reverse : result.first
end

last!()

last 相同,但如果找不到記錄,會引發 ActiveRecord::RecordNotFound。請注意,last! 不接受任何參數。

# File activerecord/lib/active_record/relation/finder_methods.rb, line 205
def last!
  last || raise_record_not_found_exception!
end

member?(record)

別名:include?

second()

尋找第二筆記錄。如果未定義順序,它將按主鍵排序。

Person.second # returns the second object fetched by SELECT * FROM people
Person.offset(3).second # returns the second object from OFFSET 3 (which is OFFSET 4)
Person.where(["user_name = :u", { u: user_name }]).second
# File activerecord/lib/active_record/relation/finder_methods.rb, line 215
def second
  find_nth 1
end

second!()

second 相同,但如果找不到記錄,會引發 ActiveRecord::RecordNotFound

# File activerecord/lib/active_record/relation/finder_methods.rb, line 221
def second!
  second || raise_record_not_found_exception!
end

second_to_last()

尋找倒數第二筆記錄。如果未定義順序,它將按主鍵排序。

Person.second_to_last # returns the second-to-last object fetched by SELECT * FROM people
Person.offset(3).second_to_last # returns the second-to-last object from OFFSET 3
Person.where(["user_name = :u", { u: user_name }]).second_to_last
# File activerecord/lib/active_record/relation/finder_methods.rb, line 311
def second_to_last
  find_nth_from_last 2
end

second_to_last!()

second_to_last 相同,但如果找不到記錄,則會引發 ActiveRecord::RecordNotFound

# File activerecord/lib/active_record/relation/finder_methods.rb, line 317
def second_to_last!
  second_to_last || raise_record_not_found_exception!
end

sole()

找出符合條件的唯一記錄。如果找不到任何記錄,則引發 ActiveRecord::RecordNotFound。如果找到多於一筆記錄,則引發 ActiveRecord::SoleRecordExceeded

Product.where(["price = %?", price]).sole
# File activerecord/lib/active_record/relation/finder_methods.rb, line 135
def sole
  found, undesired = first(2)

  if found.nil?
    raise_record_not_found_exception!
  elsif undesired.present?
    raise ActiveRecord::SoleRecordExceeded.new(self)
  else
    found
  end
end

take(limit = nil)

提供一個記錄(如果提供參數,則為 N 個記錄),而沒有任何隱含的順序。順序將取決於資料庫實作。如果提供順序,則會尊重它。

Person.take # returns an object fetched by SELECT * FROM people LIMIT 1
Person.take(5) # returns 5 objects fetched by SELECT * FROM people LIMIT 5
Person.where(["name LIKE '%?'", name]).take
# File activerecord/lib/active_record/relation/finder_methods.rb, line 120
def take(limit = nil)
  limit ? find_take_with_limit(limit) : find_take
end

take!()

take 相同,但如果找不到記錄,則會引發 ActiveRecord::RecordNotFound。請注意,take! 不接受任何參數。

# File activerecord/lib/active_record/relation/finder_methods.rb, line 126
def take!
  take || raise_record_not_found_exception!
end

third()

尋找第三筆記錄。如果沒有定義順序,則會按主鍵排序。

Person.third # returns the third object fetched by SELECT * FROM people
Person.offset(3).third # returns the third object from OFFSET 3 (which is OFFSET 5)
Person.where(["user_name = :u", { u: user_name }]).third
# File activerecord/lib/active_record/relation/finder_methods.rb, line 231
def third
  find_nth 2
end

third!()

third 相同,但如果找不到記錄,則會引發 ActiveRecord::RecordNotFound

# File activerecord/lib/active_record/relation/finder_methods.rb, line 237
def third!
  third || raise_record_not_found_exception!
end

third_to_last()

尋找第三筆最後的記錄。如果沒有定義順序,則會按主鍵排序。

Person.third_to_last # returns the third-to-last object fetched by SELECT * FROM people
Person.offset(3).third_to_last # returns the third-to-last object from OFFSET 3
Person.where(["user_name = :u", { u: user_name }]).third_to_last
# File activerecord/lib/active_record/relation/finder_methods.rb, line 295
def third_to_last
  find_nth_from_last 3
end

third_to_last!()

third_to_last 相同,但若找不到記錄,會引發 ActiveRecord::RecordNotFound

# File activerecord/lib/active_record/relation/finder_methods.rb, line 301
def third_to_last!
  third_to_last || raise_record_not_found_exception!
end