|
| 1 | +.. http://www.mongodb.org/display/DOCS/Ruby+Language+Center |
| 2 | + |
| 3 | +.. _ruby-language-center: |
| 4 | + |
| 5 | +=================== |
| 6 | +Ruby MongoDB Driver |
| 7 | +=================== |
| 8 | + |
| 9 | +.. default-domain:: mongodb |
| 10 | + |
| 11 | +The MongoDB Ruby driver is the officially supported Ruby driver for |
| 12 | +MongoDB. It is written in pure Ruby and is optimized for simplicity. It |
| 13 | +can be used on its own, but it also serves as the basis of several |
| 14 | +object mapping libraries. |
| 15 | + |
| 16 | +Get Started |
| 17 | +----------- |
| 18 | + |
| 19 | +To get started with the Ruby driver, see :doc:`/installation` and |
| 20 | +:doc:`/quick-start`. |
| 21 | + |
| 22 | +BSON |
| 23 | +---- |
| 24 | + |
| 25 | +The Ruby BSON implementation is packaged in a separate gem with C and |
| 26 | +Java extensions for speed depending on the runtime enviroment. |
| 27 | + |
| 28 | +For reference on the Ruby BSON gem, see :doc:`/bson-tutorials`. |
| 29 | + |
| 30 | +Object Mappers |
| 31 | +-------------- |
| 32 | + |
| 33 | +Because MongoDB is so easy to use, the basic Ruby driver can be the |
| 34 | +best solution for many applications. But if you need validations, |
| 35 | +associations, and other high-level data modeling functions, then you |
| 36 | +may need Object Document Mapper may be needed. |
| 37 | + |
| 38 | +In the context of a Rails application, an Object Document Mapper |
| 39 | +provides functionality equivalent to, but distinct from, ActiveRecord. |
| 40 | +Because MongoDB is a document-based database, these mappers are called |
| 41 | +Object Document Mappers (ODM) as opposed to Object Relational Mappers |
| 42 | +(ORM). |
| 43 | + |
| 44 | +The ODM officially supported by MongoDB is Mongoid, originally written |
| 45 | +by Durran Jordan. |
| 46 | + |
| 47 | +For tutorials on Mongoid, see :doc:`/mongoid-tutorials`. |
| 48 | + |
| 49 | +.. COMMENT For the actual build, see mongodb/docs-ruby repo which pulls the documentation source from: |
| 50 | +.. mongo-ruby-driver, |
| 51 | +.. bson-ruby, and |
| 52 | +.. mongoid repos. |
| 53 | + |
| 54 | +.. class:: hidden |
| 55 | + |
| 56 | + .. toctree:: |
| 57 | + :titlesonly: |
| 58 | + |
| 59 | + installation |
| 60 | + quick-start |
| 61 | + ruby-driver-tutorials |
| 62 | + bson-tutorials |
| 63 | + mongoid-tutorials |
| 64 | + API <http://api.mongodb.com/ruby/current/> |
| 65 | + /reference/driver-compatibility |
| 66 | + /reference/additional-resources |
| 67 | + /contribute |
0 commit comments