github-migration/mongo-ruby-driver
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix some TUTORIAL markdown.

Browse Source 
* Escape _ for bson_ext.
* Fix insert example.
* Un-escape _id, not required with backtick quotes.

Signed-off-by: Laurent Arnoud <laurent@spkdev.net>
This commit is contained in:
Laurent Arnoud 2011-08-24 23:15:17 +02:00
parent d552d603a8
commit 5e7b4ba416
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/TUTORIAL.md
View File

@ -15,7 +15,7 @@ Next, install the mongo rubygem:
The required `bson` gem will be installed automatically. The required `bson` gem will be installed automatically.
For optimum performance, install the bson_ext gem: For optimum performance, install the bson\_ext gem:
gem install bson_ext gem install bson_ext
@ -98,7 +98,7 @@ Once you have the collection object, you can insert documents into the collectio
Notice that the above has an "inner" document embedded within it. To do this, we can use a Hash or the driver's OrderedHash (which preserves key order) to create the document (including the inner document), and then just simply insert it into the collection using the `insert()` method. Notice that the above has an "inner" document embedded within it. To do this, we can use a Hash or the driver's OrderedHash (which preserves key order) to create the document (including the inner document), and then just simply insert it into the collection using the `insert()` method.
doc = {"name" => "MongoDB", "type" => "database", "count" => 1, doc = {"name" => "MongoDB", "type" => "database", "count" => 1,
"info" => {"x" => 203, "y" => '102'` "info" => {"x" => 203, "y" => '102'}}
coll.insert(doc) coll.insert(doc)
#### Updating a Document #### Updating a Document
@ -126,7 +126,7 @@ and you should see:
{"_id"=>#<BSON::ObjectID:0x118576c ...>, "name"=>"MongoDB", {"_id"=>#<BSON::ObjectID:0x118576c ...>, "name"=>"MongoDB",
"info"=>{"x"=>203, "y"=>102}, "type"=>"database", "count"=>1} "info"=>{"x"=>203, "y"=>102}, "type"=>"database", "count"=>1}
Note the `\_id` element has been added automatically by MongoDB to your document. Note the `_id` element has been added automatically by MongoDB to your document.
#### Adding Multiple Documents #### Adding Multiple Documents