データ操作の実行

作成します。

モデルクラスの create! メソッドを使用して、1 つ以上のドキュメントをコレクションに挿入します。サーバーまたは検証エラーが発生した場合、create! は例外を発生させます。

create! を呼び出すには、挿入するドキュメントを定義する属性のハッシュを渡します。複数のドキュメントを作成して挿入する場合は、ハッシュの配列を渡します。

この例では、 create! を呼び出す複数の方法を示しています。最初の例では1 つの Personドキュメントを作成し、2 番目の例では2 つの Person ドキュメントを作成します。 3 つ目の例ではdo..end ブロックを create! に渡します。 Mongoid は、create! に渡されたドキュメントを引数としてこのブロックを呼び出します。 create! メソッドは、ブロックの最後にドキュメントを保存しようとします。

Person.create!(
  first_name: "Heinrich",
  last_name: "Heine"
)
Person.create!([
  { first_name: "Heinrich", last_name: "Heine" },
  { first_name: "Willy", last_name: "Brandt" }
])
Person.create!(first_name: "Heinrich") do |doc|
  doc.last_name = "Heine"
end

create

新しいドキュメントまたは複数の新しいドキュメントをデータベースに挿入するには、 create メソッドを使用します。 create は、! サフィックスが付いたバージョンとは異なり、検証エラーの例外を発生させません。 create は、重複する _idフィールドを持つドキュメントを挿入した場合など、サーバーエラーに対して例外を発生させます。

create で検証エラーが発生した場合、ドキュメントは挿入されず、挿入された他のドキュメントとともに返されます。 persisted?、new_record?、または errors メソッドを使用して、データベースに挿入されたドキュメントを検証できます。

この例では、 create を使用して新しいドキュメントをMongoDBに挿入する方法を示します。最初の例は、 Personドキュメントを挿入する方法を示しています。 2 番目の例では2 つの Post ドキュメントを挿入しようとしていますが、2 番目のドキュメントには重複するタイトルが含まれているため、検証に失敗します。次に、この例では persisted? メソッドを使用して、どのドキュメントがコレクションに正常に挿入されたかを確認します。

Person.create(
  first_name: "Heinrich",
  last_name: "Heine"
)
class Post
  include Mongoid::Document
  validates_uniqueness_of :title
end
posts = Post.create([{title: "test"}, {title: "test"}])
posts.map { |post| post.persisted? } # => [true, false]

persisted?new_record?メソッドと メソッドの詳細については、このガイドの 永続性属性のセクション を参照してください。

save!

変更された属性をコレクションにアトミックに保存したり、新しいドキュメントを挿入したりするには、save! メソッドを使用します。サーバーまたは検証エラーが発生した場合、save! は例外を発生させます。 new メソッドを使用して新しいドキュメントインスタンスを作成できます。次に、save! を使用してドキュメントをデータベースに挿入します。

次の例では、 save! を使用して新しい Personドキュメントを挿入し、既存のドキュメントの first_nameフィールドを更新する方法を示します。

person = Person.new(
  first_name: "Esmeralda",
  last_name: "Qemal"
)
person.save!
person.first_name = "Malik"
person.save!

保存

save メソッドは、検証エラーが発生した場合に例外を発生させません。サーバーエラーが発生した場合、save は引き続き例外を発生させます。このメソッドは、変更された属性がすべて保存されている場合は true を返し、検証エラーが発生した場合は false を返します。

次のオプションを save に渡すことができます。

• validate: false: 新しいドキュメントまたは更新された属性を保存するときに検証をバイパスします。

• touch: false: 指定された属性を更新するときに updated_atフィールドを更新しないようにします。このオプションは、新しいドキュメントを挿入する場合には効果がありません。

次のコードでは、save を使用して新しいドキュメントを挿入します。次に、そのドキュメントを更新し、validate: false オプションを適用します。

person = Person.new(
  first_name: "Tamara",
  last_name: "Graham"
)
person.save
person.first_name = "Aubrey"
person.save(validate: false)

属性

attributes メソッドを使用して、モデルインスタンスの属性をハッシュとして検索できます。このハッシュには、すべての埋め込みドキュメントの属性も含まれます。

次の例は、 attributes の使用方法を示しています。

person = Person.new(first_name: "James", last_name: "Nan")
person.save
puts person.attributes

{ "_id" => BSON::ObjectId('...'),
  "first_name" => "James",
  "last_name" => "Nan"
}

再読み込み

MongoDBからドキュメントの最新バージョンにアクセスするには、reload メソッドを使用します。ドキュメント を再読み込みすると、Mongoid は同じクエリにあるすべての埋め込み関連付けも再読み込みします。ただし、Mongoid は参照された関連付けを再読み込みしません。代わりに、次回のアクセス時にデータベースからロードされるように、これらの値をクリアします。

ドキュメントで reload を呼び出すと、ドキュメントに対する保存されていない変更はすべて失られます。次のコードは、ドキュメントで reload を呼び出す方法を示しています。

band = Band.create!(name: 'Sun 1')
# => #<Band _id: ..., name: "Sun 1">
band.name = 'Moon 2'
# => #<Band _id: ..., name: "Moon 2">
band.reload
# => #<Band _id: ..., name: "Sun 1">

上記の例では、 bandドキュメントの nameフィールドを更新しますが、新しい値は保存しません。 Mongoid は name 値への変更を永続化しなかったため、name にはデータベースに保存された元の 値が含まれます。

existing = Band.create!(name: 'Photek')
band = Band.new(id: existing.id)
band.reload
puts band.name

Photek

update_attributes!

既存の モデルインスタンスの属性を更新するには、update_attributes! メソッドを使用します。このメソッドは、検証またはサーバーエラーが発生した場合に例外を発生させます。

次の例では、 update_attributes! を使用して既存のドキュメントの first_name 属性と last_name 属性を更新する方法を示します。

person.update_attributes!(
  first_name: "Maximilian",
  last_name: "Hjalmar"
)

update_attributes

update_attributes メソッドは検証エラーの例外を発生させません。このメソッドは、検証に合格し、ドキュメントが更新された場合は true を返し、そうでない場合は false を返します。

次の例は、 update_attributes の使用方法を示しています。

person.update_attributes(
  first_name: "Hasan",
  last_name: "Emine"
)

update_attribute

update_attributeメソッドを使用して検証をバイパスし、 モデルインスタンスの単一の属性を更新できます。

次の例では、 update_attribute を使用してドキュメントの first_name 属性の値を更新する方法を示しています。

person.update_attribute(:first_name, "Jean")

upsert

upsert メソッドを使用して、ドキュメント を更新、挿入、または置換できます。

upsert は replace オプションを受け入れます。このオプションを true に設定しており、upsert を呼び出すドキュメントがデータベースにすでに存在する場合、新しいドキュメントがデータベース内のドキュメントに置き換えられます。新しいドキュメントに置き換えられないデータベース内のフィールドは削除されます。

replace オプションを false に設定しており、ドキュメントがデータベースに存在する場合は更新されます。 Mongoid は、 更新ドキュメントで指定されたフィールド以外のフィールドを変更しません。ドキュメントがデータベースに存在しない 場合は、 アップデートドキュメントで指定されたフィールドと値が挿入されます。 replace オプションはデフォルトで false に設定されています。

次の例では、 upsert を使用してまず新しいドキュメントを挿入し、次に replace: true を設定して置き換える方法を示します。

person = Person.new(
  first_name: "Balu",
  last_name: "Rama"
)
person.upsert
person.first_name = "Ananda"
person.upsert(replace: true)

access

touch メソッドを使用して、ドキュメントの updated_at タイムスタンプを現在の時刻に更新できます。 touch は、ドキュメントの belongs_to 関連付けのいずれかへの更新をカスケードします。オプションとして別の時間値フィールドを渡して、そのフィールドを更新することもできます。

次の例では、 touch を使用して updated_at と audited_at のタイムスタンプを更新します。

person.touch(:audited_at)

削除

データベースからドキュメントを削除するには、delete メソッドを使用します。 delete を使用すると、Mongoid はコールバックを実行しません。ドキュメントがデータベースに保存されていない場合、delete は同じ _id 値を持つドキュメントを削除しようとします。

次の例では、 delete メソッドの使用方法を示し、データベースに保存されていないドキュメントを削除した場合に何が起こるかを示します。

person = Person.create!(name: 'Edna Park')
unsaved_person = Person.new(id: person.id)
unsaved_person.delete
person.reload

前述の例では、 を呼び出すと MongoidMongoid::Errors::DocumentNotFound reloadunsaved_person.deletepersonは_id エラーを発生させます。これは、2 つのドキュメントで の値が同じであるためです。

破棄する

destroy メソッドは delete と同様に動作しますが、destroy を呼び出すと Mongoid がコールバックを実行します。ドキュメントがデータベースで見つからない場合、destroy は同じ _id を持つドキュメントを削除しようとします。

次の例は、 destroy の使用方法を示しています。

person.destroy

delete_all

delete_all メソッドは、 Mongoid モデルクラスによってモデル化されているすべてのドキュメントをコレクションから削除します。 delete_all はコールバックを実行しません。

次の例は、 delete_all を使用してすべての Person ドキュメントを削除する方法を示しています。

Person.delete_all

delete_all

destroy_all メソッドは、 Mongoid モデルクラスによってモデル化されているすべてのドキュメントをコレクションから削除します。 Mongoid はすべてのドキュメントをメモリにロードするため、これはコストのかかる操作になる可能性があります。

次の例は、 destroy_all を使用してすべての Person ドキュメントを削除する方法を示しています。

Person.destroy_all

new_record?

new_record?true属性は、モデルインスタンスがまだデータベースに保存されていない場合は を返し、それ以外の場合はfalse を返します。逆の条件としてpersisted? 属性がチェックされます。

次の例は、 new_record? の使用方法を示しています。

person = Person.new(
  first_name: "Tunde",
  last_name: "Adebayo"
)
puts person.new_record?
person.save!
puts person.new_record?

true
false

永続化された場合

persisted? 属性は、Mongoid が モデルインスタンスを保持する場合は true を返し、それ以外の場合は false を返します。逆の条件として new_record? 属性がチェックされます。

次の例は、 persisted? の使用方法を示しています。

person = Person.new(
  first_name: "Kiana",
  last_name: "Kahananui"
)
puts person.persisted?
person.save!
puts person.persisted?

false
true

フィールド値の取得と設定

ドキュメントのフィールド値を取得して設定するには、複数の方法があります。フィールドを明示的に 宣言すると、ドキュメントでこのフィールド値を直接取得して設定できます。次の例は、Personインスタンスの first_nameフィールドを設定して取得する方法を示しています。

class Person
  include Mongoid::Document
  field :first_name
end
  
person = Person.new
  
person.first_name = "Artem"
person.first_name # => "Artem"

上記の例では、まず first_name 属性を使用して値を設定し、次にその属性を再度呼び出して値を取得します。

また、Mongoid モデルインスタンスで [] メソッドと [] = メソッドを使用して、 ハッシュ構文 を使用して属性にアクセスすることもできます。 [] メソッドは read_attribute メソッドのエイリアスであり、[] = メソッドは write_attribute メソッドのエイリアスです。次の例は、 [] メソッドと []= メソッドを使用してエイリアス first_nameフィールドを取得して設定する方法を示しています。

class Person
  include Mongoid::Document
  
  field :first_name, as: :fn
end
  
person = Person.new(first_name: "Artem")
  
person["fn"]
# => "Artem"
person[:first_name] = "Vanya"
# => "Artem"
person
# => #<Person _id: ..., first_name(fn): "Vanya">

これらのメソッドの詳細については、このガイドの次の read_attribute および write_attribute セクションを参照してください。

read_attribute と write_attribute

read_attribute メソッドと write_attribute メソッドを使用して、フィールドの読み取りまたは書き込み時にカスタム動作を指定できます。これらのメソッドは、モデルを定義するとき、またはモデル インスタンスで呼び出して使用できます。

read_attribute を使用してフィールド を取得するには、フィールドの名前を メソッドに渡します。 write_attribute を使用してフィールド を設定するには、フィールドの名前と割り当てる値を渡します。

次の例では、モデル定義で read_attribute と write_attribute を使用して、fn 属性の読み取りと書込みに使用されるメソッドとして first_name と first_name= を定義します。

class Person
  include Mongoid::Document
  def first_name
    read_attribute(:fn)
  end
  def first_name=(value)
    write_attribute(:fn, value)
  end
end
  
person = Person.new
person.first_name = "Artem"
person.first_name
# => "Artem"

また、モデルインスタンスで read_attribute と write_attribute を直接呼び出して、属性を取得して設定することもできます。次の例では、モデルインスタンスでこれらのメソッドを使用して first_name 属性を取得し、それを値 "Pushkin" に設定します。

class Person
  include Mongoid::Document
  field :first_name, as: :fn
end
  
person = Person.new(first_name: "Artem")
# => #<Person _id: ..., first_name(fn): "Artem">
person.read_attribute(:first_name)
# => "Artem"
person.read_attribute(:fn)
# => "Artem"
person.write_attribute(:first_name, "Pushkin")
person
# => #<Person _id: ..., first_name(fn): "Pushkin">

一括書込み (write) 属性

モデルインスタンスで attributes= メソッドまたは write_attributes メソッドを使用して、同時に複数のフィールドに書き込むことができます。

attributes= メソッドを使用するには、モデルインスタンスで メソッドを呼び出し、設定するフィールドと値を含むハッシュオブジェクトを渡します。次の例は、 attributes= メソッドを使用して personドキュメントの first_name フィールドと middle_name フィールドを設定する方法を示しています。

person.attributes = { first_name: "Jean-Baptiste", middle_name: "Emmanuel" }

write_attributes メソッドを使用するには、モデルインスタンスで メソッドを呼び出し、設定するフィールドと値を渡します。次の例は、 write_attributes メソッドを使用して personドキュメントの first_name フィールドと middle_name フィールドを設定する方法を示しています。

person.write_attributes(
  first_name: "Jean-Baptiste",
  middle_name: "Emmanuel",
)

グループ アトミック操作

アトミック操作をグループ化するには、 モデルインスタンスで atomically メソッドを使用できます。 Mongoid は、単一のアトミック コマンドで atomically ブロックに渡すすべての操作を送信します。

次の例は、 atomically を使用してドキュメント内の複数のフィールドを不可分的に更新する方法を示しています。

person.atomically do
  person.inc(age: 1)
  person.set(name: 'Jake')
end

単一のドキュメントを更新するときに #atomically ブロックをネストできます。デフォルトでは 、Mongoid はブロックが終了するときに、各ブロックに定義されたアトミック書込みを実行します。次の例は、 atomically ブロックをネストする方法を示しています。

person.atomically do
  person.atomically do
      person.inc(age: 1)
      person.set(name: 'Jake')
  end
  raise 'An exception'
  # Name and age changes are persisted
end

前の例では、$inc 操作と $set 操作は内部 atomically ブロックの最後に実行されています。

person.atomically do
  person.atomically(join_context: true) do
      person.inc(age: 1)
      person.set(name: 'Jake')
  end
  raise 'An exception'
  # Name and age changes are not persisted
end

変更を表示

Mongoid は、モデルがインスタンス化された時点から保存されるまで、新しいドキュメントとして、またはデータベースから取得したユーザーの変更を記録します。永続化操作により、変更がクリアされます。

Mongoid は、 モデルインスタンスへの変更を調査できるモデル固有のメソッドを作成します。次のコードは、 モデルインスタンスの変更を表示する方法を示しています。

# Retrieves a person instance
person = Person.first
# Sets a new `name` value
person.name = "Sarah Frank"
# Checks to see if the document is changed
person.changed? # true
# Gets an array of changed fields.
person.changed # [ :name ]
# Gets a hash of the old and changed values for each field
person.changes # { "name" => [ "Sarah Frink", "Sarah Frank" ] }
# Checks if a specific field is changed
person.name_changed? # true
# Gets the changes for a specific field
person.name_change # [ "Sarah Frink", "Sarah Frank" ]
# Gets the previous value for a field
person.name_was # "Sarah Frink"

変更をリセット

次のコードに示すように、reset メソッドを呼び出すことで、変更されたフィールドを以前の値にリセットできます。

person = Person.first
person.name = "Sarah Frank"
# Reset the changed `name` field
person.reset_name!
person.name # "Sarah Frink"

永続性

Mongoid は、すべての永続化操作の基盤として ダーティ 追跡 を使用します。保存のたびにドキュメント全体を書込む他のフレームワークと比較して、ドキュメントの変更を評価し、変更された内容のみをアトミックにアップデートします。変更を加えない場合、Model#save を呼び出すと、Mongoid はデータベースにアクセスしません。

以前の変更を表示

モデルをMongoDBに永続化すると、Mongoid は現在の変更をクリアします。ただし、次のコードに示すように、previous_changes メソッドを呼び出すことで、過去に行われた変更を確認できます。

person = Person.first
person.name = "Sarah Frank"
person.save # Clears out current changes
# Lists the previous changes
person.previous_changes
# { "name" => [ "Sarah Frink", "Sarah Frank" ] }