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

example docs

This commit is contained in:
Jim Menard 2009-02-03 12:16:33 -05:00
parent 1669e79241
commit 11d2cd2b45
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.rdoc
View File

@ -11,7 +11,8 @@ Start by reading the XGen::Mongo::Driver::Mongo and XGen::Mongo::Driver::DB
documentation, then move on to XGen::Mongo::Driver::Collection and documentation, then move on to XGen::Mongo::Driver::Collection and
XGen::Mongo::Driver::Cursor. XGen::Mongo::Driver::Cursor.
A quick code sample: Here is a quick code sample. See the files in the "examples" subdirectory for
many more.
require 'mongo' require 'mongo'
@ -49,17 +50,22 @@ you can install it as a gem from the source by typing
$ rake gem:install $ rake gem:install
= Demo = Examples
You can see and run the examples if you've downloaded the source. Mongo must There are many examples in the "examples" subdirectory. Samples include using
be running, of course. the driver and using the GridFS class GridStore. Mongo must be running for
these examples to work, of course.
Here's how to start mongo and run the "simple.rb" example:
$ cd path/to/mongo
$ ./mongod run
... then in another window ...
$ cd path/to/mongo-ruby-driver
$ ruby examples/simple.rb $ ruby examples/simple.rb
See also the test code, especially tests/test_db_api.rb. See also the test code, especially tests/test_db_api.rb.
For the GridFS class GridStore, see the tests.
= The Driver = The Driver