Skip to content

Commit 0408d69

Browse files
rachel-mackrachel-mack
committed
odm first draft
1 parent 1a45e9d commit 0408d69

File tree

2 files changed

+130
-0
lines changed

2 files changed

+130
-0
lines changed

‎source/odm.txt‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
=========================
2+
ORMs, ODMs, and Libraries
3+
=========================
4+
5+
.. facet::
6+
:name: genre
7+
:values: reference
8+
9+
.. meta::
10+
:description: MongoDB has ORMs, ODMs, and Libraries to simplify interactions between your app and cluster. Use the best database for Ruby, Python, Java, Node.js, PHP.
11+
:keywords: Object Oriented, abstraction, serialization, relational,
12+
13+
.. contents:: On this page
14+
:local:
15+
:backlinks: none
16+
:depth: 1
17+
:class: twocols
18+
19+
20+
`MongoDB Drivers <https://www.mongodb.com/docs/drivers/>`__ offer idiomatic APIs
21+
and helpers for most programming languages, sometimes a higher level
22+
abstraction is desirable. In particular, developers may be used to interacting with data in a
23+
more declarative fashion, for example by using ActiveRecord for Ruby. `Object-Relational Mappers
24+
<https://en.wikipedia.org/wiki/Object%E2%80%93relational_mapping>`__ (or ORMs)
25+
can improve the developer experience customizing database interactions in the
26+
following ways:
27+
28+
* Abstracting away the need for query language.
29+
* Managing serialization/deserialization of data into objects.
30+
* Enforcing schema requirements.
31+
32+
Because MongoDB is a non-relational database management system, ORMs are
33+
sometimes referred to as ODMs (Object Document Mappers), but the terms can be
34+
used interchangeably in the MongoDB domain. MongoDB, our
35+
`community
36+
<https://www.mongodb.com/docs/drivers/community-supported-drivers/>`__ and our
37+
partners provide a number of ODM libraries.
38+
39+
The following are some examples of the best MongoDB ODM libraries for a number
40+
of programming languages, including Ruby, Python, Java, Node.js, and PHP.
41+
42+
## Beanie
43+
44+
Beanie is an Asynchronous Python object-document mapper (ODM) for MongoDB, based on `Motor <https://www.mongodb.com/docs/drivers/motor/>`__ (an asynchronous MongoDB driver) and `Pydantic <https://pydantic-docs.helpmanual.io/>`__.
45+
46+
When using Beanie, each database collection has a corresponding document that is used to interact with that collection. In addition to retrieving data, Beanie allows you to add, update, and delete documents from the collection. Beanie saves you time by removing boilerplate code, and it helps you focus on the parts of your app that actually matter.
47+
48+
See the `Beanie documentation <https://beanie-odm.dev/>`__ for more information.
49+
50+
## Doctrine
51+
52+
Doctrine is a PHP MongoDB ORM, even though it’s referred to as an ODM. This library provides PHP object mapping functionality and transparent persistence for PHP objects to MongoDB, as well as a mechanism to map embedded or referenced documents. It can also create references between PHP documents in different databases and work with GridFS buckets.
53+
54+
See the `Doctrine MongoDB ODM documentation <https://www.doctrine-project.org/projects/doctrine-mongodb-odm/en/latest/index.html>`__ for more information.
55+
56+
## Mongoid
57+
58+
Most Ruby-based applications are built using the `Ruby on Rails <https://rubyonrails.org/>`__ framework. As a result, Rails’ `Active Record <https://guides.rubyonrails.org/active_record_basics.html>`__ implementation, conventions, CRUD API, and callback mechanisms are second nature to Ruby developers. So, as far as a MongoDB ORM for Ruby, the Mongoid ODM provides API parity wherever possible to ensure developers working with a Rails application and using MongoDB can do so using methods and mechanics they’re already familiar with.
59+
60+
See the `Mongoid documentation <https://www.mongodb.com/docs/mongoid/current/>`__ for more information.
61+
62+
## Mongoose
63+
64+
If you’re seeking an ORM for NodeJS and MongoDB, look no further than Mongoose. This Node.js-based Object Data Modeling (ODM) library for MongoDB is akin to an Object Relational Mapper (ORM) such as `SQLAlchemy <https://www.sqlalchemy.org/>`__. The problem that Mongoose aims to solve is allowing developers to enforce a specific schema at the application layer. In addition to enforcing a schema, Mongoose also offers a variety of hooks, model validation, and other features aimed at making it easier to work with MongoDB.
65+
66+
See the `Mongoose documentation <https://mongoosejs.com/>`__ or `MongoDB & Mongoose: Compatibility and Comparison <https://www.mongodb.com/developer/languages/javascript/mongoose-versus-nodejs-driver/>`__ for more information.
67+
68+
## MongoEngine
69+
70+
MongoEngine is a Python ORM for MongoDB. Branded as a Document-Object Mapper, it uses a simple declarative API, similar to the Django ORM.
71+
72+
It was first released in 2015 as an open-source project, and the current version is built on top of `PyMongo <https://www.mongodb.com/docs/drivers/pymongo/>`__, the official Python Driver by MongoDB.
73+
74+
See the `MongoEngine documentation <http://mongoengine.org/>`__ for more information.
75+
76+
## Prisma
77+
78+
Prisma is a `new kind of ORM <https://www.prisma.io/docs/concepts/overview/prisma-in-your-stack/is-prisma-an-orm>`__ for Node.js and Typescript that fundamentally differs from traditional ORMs. With Prisma, you define your models in the declarative `Prisma schema <https://www.prisma.io/docs/concepts/components/prisma-schema>`__, which serves as the single source of truth for your database schema and the models in your programming language. The Prisma Client will read and write data to your database in a type-safe manner, without the overhead of managing complex model instances. This makes the process of querying data a lot more natural as well as more predictable since Prisma Client always returns plain JavaScript objects.
79+
80+
Support for MongoDB was one of the most requested features since the initial release of the Prisma ORM, and was added in version 3.12.
81+
82+
See `Prisma & MongoDB <https://www.prisma.io/mongodb>`__ for more information.
83+
84+
## Spring Data MongoDB
85+
86+
If you’re seeking a Java ORM for MongoDB, Spring Data for MongoDB is the most popular choice for Java developers. The `Spring Data <https://spring.io/projects/spring-data>`__ project provides a familiar and consistent Spring-based programming model for new datastores while retaining store-specific features and capabilities.
87+
88+
Key functional areas of Spring Data MongoDB that Java developers will benefit from are a POJO centric model for interacting with a MongoDB DBCollection and easily writing a repository-style data access layer.
89+
90+
See the `Spring Data MongoDB documentation <https://spring.io/projects/spring-data-mongodb>`__ or the `Spring Boot Integration with MongoDB Tutorial <https://www.mongodb.com/compatibility/spring-boot>`__ for more information.
91+
92+
## Entity Framework Core
93+
94+
`Entity Framework Core <https://learn.microsoft.com/en-us/ef/>`__ is the most popular ORM/ODM in the .NET ecosystem. The official MongoDB Provider for EF Core allows developers to confidently use C# and EF Core when building with MongoDB for production-grade workloads. With the MongoDB Provider for EF Core, C# developers can unlock the full power of MongoDB's developer data platform to build modern applications while leveraging a familiar API interface, query paradigm (LINQ), and design patterns.
95+
96+
See the `EF Core provider documentation <https://www.mongodb.com/docs/entity-framework/current/>`__ for more information.
97+
98+
## Laravel
99+
100+
Laravel MongoDB is an official package that offers seamless integration of
101+
MongoDB with the Laravel framework. It enables developers to utilize the full
102+
suite of Laravel's powerful Eloquent features when working with MongoDB. With
103+
this package, Laravel developers can take advantage of MongoDB's flexible schema
104+
and extensive capabilities, while maintaining familiar patterns, relationships,
105+
and features such as querying, caching, and more.
106+
107+
For more details on setup and
108+
usage, refer to `Laravel MongoDB documentation
109+
<https://www.mongodb.com/docs/drivers/php/laravel-mongodb/current/>`__.
110+
111+
## Symfony
112+
113+
Doctrine MongoDB ODM, which is an Object-Document Mapper (ODM) for MongoDB and
114+
PHP, provides a way to work with MongoDB in Symfony, using the same principles
115+
as Doctrine ORM for relational databases. Doctrine ODM allows you to map PHP
116+
objects to MongoDB documents and query MongoDB by using a builder API. This
117+
mapping enables you to use other MongoDB features such as flexible schema design
118+
and advanced searches. Refer to the `Symfony MongoDB Integration page
119+
<https://www.mongodb.com/docs/drivers/php-frameworks/symfony/>`__ to learn more.
120+
121+
## Django
122+
123+
Django-MongoDB-Backend is the official MongoDB integration for Django, enabling seamless compatibility between Django and MongoDB. This integration supports many core Django features, including Models, Authentication, the Admin Panel, and, most notably, the Django ORM. It allows developers to use Django ORM methods, which are directly translated into equivalent MongoDB queries.
124+
125+
The library is currently in public preview, meaning developers can explore its
126+
capabilities, provide feedback, and request new features. However, it is not yet
127+
recommended for production use. To learn more, visit our `documentation
128+
<https://www.mongodb.com/docs/languages/python/django-mongodb/v5.0/get-started/>`__.
129+

‎source/other-document-dbs.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Other Document Database Compatibility
88

99
/documentdb-support
1010
/cosmosdb-support
11+
/odm
1112

1213
See the following pages for information about other document databases' compatibility
1314
with MongoDB:

0 commit comments

Comments
 (0)