|
1 |
| -.. _ruby-language-center: |
| 1 | +==================== |
| 2 | +{+driver-long+} |
| 3 | +==================== |
2 | 4 |
|
3 |
| -******************* |
4 |
| -Ruby MongoDB Driver |
5 |
| -******************* |
| 5 | +.. contents:: On this page |
| 6 | + :local: |
| 7 | + :backlinks: none |
| 8 | + :depth: 1 |
| 9 | + :class: twocols |
6 | 10 |
|
7 |
| -.. class:: hidden |
| 11 | +.. toctree:: |
| 12 | + :titlesonly: |
| 13 | + :maxdepth: 1 |
| 14 | + |
| 15 | + View the Source <https://github.com/mongodb/mongo-ruby-driver> |
| 16 | + API Documentation <{+api-root+}> |
8 | 17 |
|
9 |
| - .. toctree:: |
10 |
| - :titlesonly: |
| 18 | +.. TODO: |
| 19 | + Get Started </get-started> |
| 20 | + Connect </connect> |
| 21 | + Databases & Collections </databases-collections> |
| 22 | + Read Data </read> |
| 23 | + Write Data </write> |
| 24 | + Operations on Replica Sets </read-write-pref> |
| 25 | + Indexes </indexes> |
| 26 | + Monitor Your Application </monitoring> |
| 27 | + Data Aggregation </aggregation> |
| 28 | + Security </security> |
| 29 | + Issues & Help </issues-and-help> |
| 30 | + What's New </whats-new> |
| 31 | + Upgrade </upgrade> |
| 32 | + Compatibility </compatibility> |
11 | 33 |
|
12 |
| - Get Started <getting-started> |
13 |
| - Connect to MongoDB <connect> |
14 |
| - Tutorials <tutorials> |
15 |
| - Connection & Configuration <reference/connection-and-configuration> |
16 |
| - Working with Data <reference/working-with-data> |
17 |
| - Schema Operations <reference/schema-operations> |
18 |
| - API <https://mongodb.com/docs/ruby-driver/current/api/> |
19 |
| - Release Notes <release-notes> |
20 |
| - Additional Resources <reference/additional-resources> |
21 |
| - Contribute <contribute> |
| 34 | +Introduction |
| 35 | +------------ |
22 | 36 |
|
23 |
| -Welcome to the documentation site for the official MongoDB Ruby driver. |
24 |
| -You can add the driver to your application to work with MongoDB in |
25 |
| -Ruby. |
| 37 | +Welcome to the documentation site for the {+driver-long+}, the official |
| 38 | +MongoDB driver for {+language+} applications. |
26 | 39 |
|
27 |
| -Get Started |
28 |
| -=========== |
| 40 | +.. TODO: |
| 41 | +.. Get Started |
| 42 | +.. ----------- |
29 | 43 |
|
30 |
| -To get started with the Ruby driver, see :doc:`/installation` and |
31 |
| -:doc:`/tutorials/quick-start`. Continue to :doc:`/tutorials` |
32 |
| -for high level documentation for common operations. |
| 44 | +.. Learn how to install the driver, establish a connection to MongoDB, and begin |
| 45 | +.. working with data in the :ref:`ruby-get-started` tutorial. |
33 | 46 |
|
34 |
| -BSON |
35 |
| -==== |
| 47 | +.. Connect to MongoDB |
| 48 | +.. ------------------ |
36 | 49 |
|
37 |
| -The Ruby BSON implementation is packaged in a separate gem with C and |
38 |
| -Java extensions for speed depending on the runtime environment. |
| 50 | +.. Learn how to create and configure a connection to a MongoDB deployment |
| 51 | +.. in the :ref:`ruby-connect` section. |
39 | 52 |
|
40 |
| -For reference on the Ruby BSON gem, see the :doc:`/tutorials/bson`. |
| 53 | +.. Databases and Collections |
| 54 | +.. ------------------------- |
41 | 55 |
|
42 |
| -Object Mappers |
43 |
| -============== |
| 56 | +.. Learn how to use the {+driver-short+} to work with MongoDB databases and collections in the |
| 57 | +.. :ref:`ruby-databases-collections` section. |
44 | 58 |
|
45 |
| -Because MongoDB is so easy to use, the basic Ruby driver can be the |
46 |
| -best solution for many applications. But if you need validations, |
47 |
| -associations, and other high-level data modeling functions, then you |
48 |
| -may need Object Document Mapper. |
| 59 | +.. Read Data from MongoDB |
| 60 | +.. ---------------------- |
49 | 61 |
|
50 |
| -In the context of a Rails application, an Object Document Mapper |
51 |
| -provides functionality equivalent to, but distinct from, ActiveRecord. |
52 |
| -Because MongoDB is a document-based database, these mappers are called |
53 |
| -Object Document Mappers (ODM) as opposed to Object Relational Mappers |
54 |
| -(ORM). |
| 62 | +.. Learn how you can retrieve data from MongoDB in the :ref:`ruby-read` section. |
55 | 63 |
|
56 |
| -The ODM officially supported by MongoDB is Mongoid, originally written |
57 |
| -by Durran Jordan. |
| 64 | +.. Write Data to MongoDB |
| 65 | +.. --------------------- |
58 | 66 |
|
59 |
| -For tutorials on Mongoid, see the `Mongoid Manual <https://mongodb.com/docs/mongoid/master>`_. |
| 67 | +.. Learn how you can write data to MongoDB in the :ref:`ruby-write` section. |
| 68 | + |
| 69 | +.. Configure Operations on Replica Sets |
| 70 | +.. ------------------------------------ |
| 71 | + |
| 72 | +.. Learn how to configure read and write operations on a replica set in the |
| 73 | +.. :ref:`ruby-read-write-pref` section. |
| 74 | + |
| 75 | +.. Optimize Queries by Using Indexes |
| 76 | +.. --------------------------------- |
| 77 | + |
| 78 | +.. Learn how to work with common types of indexes in the :ref:`ruby-indexes` |
| 79 | +.. section. |
| 80 | + |
| 81 | +.. Transform Your Data with Aggregation |
| 82 | +.. ------------------------------------ |
| 83 | + |
| 84 | +.. Learn how to use the {+driver-short+} to perform aggregation operations in the |
| 85 | +.. :ref:`ruby-aggregation` section. |
| 86 | + |
| 87 | +.. Secure Your Data |
| 88 | +.. ---------------- |
| 89 | + |
| 90 | +.. Learn how to authenticate your application and encrypt your data in the |
| 91 | +.. :ref:`ruby-security` section. |
| 92 | + |
| 93 | +.. What's New |
| 94 | +.. ---------- |
| 95 | + |
| 96 | +.. For a list of new features and changes in each version, see the :ref:`What's New <ruby-whats-new>` |
| 97 | +.. section. |
| 98 | + |
| 99 | +.. Upgrade Driver Versions |
| 100 | +.. ----------------------- |
| 101 | + |
| 102 | +.. Learn what changes you must make to your application to upgrade driver |
| 103 | +.. versions in the :ref:`ruby-upgrade` section. |
| 104 | + |
| 105 | +.. Compatibility |
| 106 | +.. ------------- |
| 107 | + |
| 108 | +.. To learn about the versions of the {+mdb-server+} and the {+language+} language |
| 109 | +.. that are compatible with each version of the {+driver-short+}, see the |
| 110 | +.. :ref:`Compatibility <ruby-compatibility>` section. |
| 111 | + |
| 112 | +Developer Hub |
| 113 | +------------- |
| 114 | + |
| 115 | +The Developer Hub provides tutorials and social engagement for |
| 116 | +developers. |
| 117 | + |
| 118 | +To ask questions and engage in discussions with fellow developers who |
| 119 | +use the {+driver-short+}, see the `forums page. <https://www.mongodb.com/community/forums/tag/ruby>`__ |
0 commit comments