DOCSP-45364: CRUD pt 1

source/includes/interact-data/crud.rb

@@ -0,0 +1,267 @@
+# start create! example
+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
+# end create! example
+
+# start create example
+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]
+# end create example
+
+# start save! example
+person = Person.new(
+  first_name: "Esmeralda",
+  last_name: "Qemal"
+)
+person.save!
+
+person.first_name = "Malik"
+person.save!
+# end save! example
+
+# start save example
+person = Person.new(
+  first_name: "Tamara",
+  last_name: "Graham"
+)
+person.save
+
+person.first_name = "Aubrey"
+person.save(validate: false)
+# end save example
+
+# start attributes example
+person = Person.new(first_name: "James", last_name: "Nan")
+person.save
+
+puts person.attributes
+# end attributes example
+
+# start reload example
+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">
+# end reload example
+
+# start reload unsaved example
+existing = Band.create!(name: 'Photek')
+
+band = Band.new(id: existing.id)
+band.reload
+
+puts band.name
+# end reload unsaved example
+
+# start update attributes! example
+person.update_attributes!(
+  first_name: "Maximilian",
+  last_name: "Hjalmar"
+)
+# end update attributes! example
+
+# start update attributes example
+person.update_attributes(
+  first_name: "Hasan",
+  last_name: "Emine"
+)
+# end update attributes example
+
+# start update attribute example
+person.update_attribute(:first_name, "Jean")
+# end update attribute example
+
+# start upsert example
+person = Person.new(
+  first_name: "Balu",
+  last_name: "Rama"
+)
+person.upsert
+
+person.first_name = "Ananda"
+person.upsert(replace: true)
+# end upsert example
+
+# start touch example
+person.touch(:audited_at)
+# end touch example
+
+# start delete example
+person.delete
+person = Person.create!(name: 'Edna Park')
+
+unsaved_person = Person.new(id: person.id)
+unsaved_person.delete
+person.reload
+# end delete example
+
+# start destroy example
+person.destroy
+# end destroy example
+
+# start delete all example
+Person.delete_all
+# end delete all example
+
+# start destroy all example
+Person.destroy_all
+# end destroy all example
+
+# start new record example
+person = Person.new(
+  first_name: "Tunde",
+  last_name: "Adebayo"
+)
+puts person.new_record?
+
+person.save!
+puts person.new_record?
+# end new record example
+
+# start persisted example
+person = Person.new(
+  first_name: "Kiana",
+  last_name: "Kahananui"
+)
+puts person.persisted?
+
+person.save!
+puts person.persisted?
+# end persisted example
+
+# start field values default
+class Person
+  include Mongoid::Document
+  field :first_name
+end
+
+person = Person.new
+
+person.first_name = "Artem"
+person.first_name # => "Artem"
+# end field values default
+
+# start field values hash
+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">
+# end field values hash
+
+# start read write attributes
+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"
+# end read write attributes
+
+# start read write instance
+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">
+# end read write instance
+
+# start attributes= example
+person.attributes = { first_name: "Jean-Baptiste", middle_name: "Emmanuel" }
+# end attributes= example
+
+# start write_attributes example
+person.write_attributes(
+  first_name: "Jean-Baptiste",
+  middle_name: "Emmanuel",
+)
+# end write_attributes example
+
+# start atomically example
+person.atomically do
+  person.inc(age: 1)
+  person.set(name: 'Jake')
+end
+# end atomically example
+
+# start default block atomic example
+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
+# end default block atomic example
+
+# start join_contexts atomic
+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
+# end join_contexts atomic

source/interact-data.txt

@@ -14,6 +14,7 @@ Interact with Data
 .. toctree::
    :caption: Interact with Data
 
+   Perform Data Operations </interact-data/crud>
    Specify a Query </interact-data/specify-query>
    Modify Query Results </interact-data/modify-results>
    Search Text </interact-data/text-search>
@@ -23,6 +24,9 @@ Interact with Data
 In this section, you can learn how to use {+odm+} to interact with your
 MongoDB data.
 
+- :ref:`mongoid-data-crud`: Learn how to create, read, update, and
+  delete documents in a collection.
+
 - :ref:`mongoid-data-specify-query`: Learn how to construct
   queries to match specific documents in a MongoDB collection.