ZendCon2010 Doctrine MongoDB ODM

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Jonathan H. Wage OpenSky
Doctrine MongoDB
Object Document Mapper
+

Who am I?
Jonathan H. Wage
PHP Developer for over 10 years
Symfony Contributor
Doctrine Contributor
Published Author
Busin...

I work at
What is OpenSky?
“a social commerce platform”
Based in New York and is a major open
source software advocate
htt...

OpenSky Technologies
PHP 5.3.2
Apache2
Symfony2
Doctrine2
jQuery
mule, stomp, hornetq
MongoDB
nginx
varnish

What is Doctrine?
- Open Source PHP Project started in
2006
- Specializes in database functionality

Doctrine Libraries
- Database Abstraction Layer
- Database Migrations
- Object Relational Mapper
- MongoDB Object Document...

Who is on the team?
• Roman S. Borschel
• Guilherme Blanco
• Benjamin Eberlei
• Bulat Shakirzyanov
• Jonathan H.Wage

Project History
- First commit April 13th 2006
- First stable version ﬁnished and Released September
1st 2008
- One of the...

What is MongoDB?
http://en.wikipedia.org/wiki/MongoDB
“MongoDB (from "humongous") is an open source,
scalable, high-perfor...

Database Terminology
RDBMS MongoDB
Database Database
Table Collection
Row Document

Mapper Terminology
ORM ODM
Database Database
Repository Repository
Entity Document

Using MongoDB in PHP
Download and run MongoDB Server
http://www.mongodb.org/display/DOCS/Downloads
Install Mongo PECL exte...

Connecting
Create new connection instances with
the Mongo class:
$mongo = new Mongo('mongodb://localhost');

Selecting Databases
MongoDB intances can be selected
using the selectDB() method:
$mongo = new Mongo('mongodb://localhost'...

Selecting Collections
MongoCollection instances can be
selected using the selectCollection()
method:
$mongo = new Mongo('m...

Inserting Documents
Insert a regular PHP array:
$user = array(
'username' => 'jwage',
'password' => md5('changeme')
'activ...

Finding a Document
We can easily ﬁnd the document we just
inserted using the ﬁndOne() method:
$user = $coll->findOne(array...

Updating a Document
You can ﬁnd a document, change it and
save the entire document:
$user = $coll->findOne(array('username...

Atomic Updates
The following is faster and safer:
$coll->update(array(
'username' => 'jwage'
), array(
'$set' => array(
'u...

Atomic Updates
$inc - increments field by the number value
$set - sets field to value
$unset - deletes a given field
$push - ...

Atomic Examples
Increment num_comments with $inc:
// $inc a blog posts number of comments by 1
$db->posts->update($id, arr...

Atomic Examples
Push new comment on to end of array:
// $push a new comment on to a blog posts comments
$db->posts->update...

Atomic Examples
Set an individual ﬁeld value:
// $set a lock on a blog post
$db->posts->update($id, array('$set' => array(...

Atomic Examples
Unset a ﬁeld from a document:
// $unset a lock on a blog post
$db->posts->update($id, array('$unset' => ar...

Removing Documents
You can remove documents using the
remove() method:
$coll->remove(array('username' => 'jwage'));

+
Doctrine + MongoDB
=

What is it?
- Layer on top of Mongo PECL extension
- Work with objects instead of arrays
- Create rich OO PHP domain and p...

What does it do?
- Maps PHP classes to MongoDB
- Manages the state of objects
- Tracks changes and persists them
- Constru...

How does it do it?
- Implements UnitOfWork
http://martinfowler.com/eaaCatalog/unitOfWork.html
- Tracks changes to managed ...

Easier to build than ORM
- Less work to convert objects to arrays
for persistence to MongoDB
- Less work to convert the da...

Architecture
Documents
- Lightweight persistent domain object
- Regular PHP class
- Does not extend any base Doctrine clas...

Architecture
- No more base class required
- Values stored in object properties
- Doctrine is transparent
namespace Docume...

Architecture
The DocumentManager
- Central access point to the ODM functionality provided by
Doctrine. API is used to mana...

Managing Documents
To manage documents with Doctrine
you need a DocumentManager:
$config = new DoctrineODMMongoDBConfigura...

DocumentManager
The DocumentManager is the central
place for managing the state of PHP
objects. It has methods like:
persi...

Document Classes
A Doctrine MongoDB Document is just a regular old PHP object:
class User
{
private $id;
private $username...

Mapping Information
- Annotations
- YAML
- XML
- PHP
/** @Document */
class User
{
/** @Id */
private $id;
/** @String */
...

Inserting Documents
$user = new User();
$user->setUsername('jwage');
$user->setPassword('changeme');
$dm->persist($user);
...

Finding Documents
$user = $dm->findOne('User', array('username' => 'jwage'));

Updating Documents
Always uses atomic operators
$user = $dm->findOne('User', array('username' => 'jwage'));
$user->setUser...

Removing Documents
$user = $dm->findOne('User', array('username' => 'jwage'));
$dm->remove($user);
$dm->flush(); // remove...

Query Builder
Normally queries are just arrays that
look like the following:
$user = $dm->findOne('User', array('username'...

Problems
- Not OO
- Not re-usable
- Can become difficult to read as query
gets more complex

Query Builder
Construct a new query instance and
start adding to it:
$q = $dm->createQuery('User')
->field('username')->eq...

Query Builder
Find posts within a range of dates:
$q = $dm->createQuery('Post')
->field('createdAt')->range($startDate, $e...

Query Builder
Updating documents:
$q = $dm->createQuery('User')
->update()
->field('username')->set('jonwage')
->field('pa...

Query Builder
Removing documents:
$q = $dm->createQuery('User')
->remove()
->field('username')->equals('jwage');

Query Builder
Executing queries:
// Execute and get the first result
$user = $q->getSingleResult();
// Execute and return ...

Embedded Documents
Insert document with an embedded
document:
$user = array(
'username' => 'jwage',
'password' => 'changem...

Embedded Documents
Push a new address on to the end of
the addresses array:
$db->users->update($user['_id'], array('$push'...

Embedded Mapping
Map an embedded document using
@EmbedOne and @EmbedMany:
class User
{
/** @Id */
public $id;
/** @String ...

/** @EmbeddedDocument */
class Address
{
/** @String */
public $address;
/** @String */
public $city;
/** @String */
publi...

$user = new User();
$user->name = 'Jonathan H. Wage';
$address = new Address();
$address->address = '6512 Mercomatic Ct';
...

$users = array(
array(
'name' => 'Jonathan H. Wage',
'addresses' => array(
array(
'address' => '6512 Mercomatic Ct',
'city...

Updating Embedded Documents
$user = $dm->findOne('User', array('name' => 'Jonathan H. Wage'));
$user->addresses[0]->zipcod...

Adding new Address
$user = $dm->findOne('User', array('name' => 'Jonathan H. Wage'));
$address = new Address();
$address->...

Unsetting Properties
unset($user->addresses[0]->zipcode);
$dm->flush();
$coll->update(
array('_id' => 'theuserid'),
array(...

References
Reference documents from within
another document by storing an
embedded document with the following
properties:...

References
- No JOIN syntax like in a relational DB
- References are resolved in app code
- Store one or many references

Reference Mapping
/** @Document */
class Organization
{
/** @Id */
private $id;
/** @String */
private $name;
/** @Referen...

Reference Mapping
/** @Document */
class User
{
/** @Id */
private $id;
/** @String */
private $name;
/** @ReferenceOne(ta...

Persisting
$organization = new Organization();
$organization->setName('Sensio Labs');
$user = new User();
$user->setName('...

Inserted Organization
Resulting organization has a reference
to the user:
Array
(
[_id] => 4c86acd78ead0e8759000000
[name]...

Inserted User
Resulting user has a reference to the
organization:
Array
(
[_id] => 4c86acd78ead0e8759010000
[name] => Jona...

Working with References
A single reference is represented by a
proxy object:
$user = $dm->find('User', array('name' => 'Jo...

Working with References
What does a proxy look like?
class OrganizationProxy extends Organization
{
private function initi...

Working with References
A many reference is represented by an
uninitialized PersistentCollection:
$organization = $dm->fin...

Document Query Language
SQLike grammar for querying Doctrine
MongoDB ODM for document objects.
find all FROM BlogPost

QueryLanguage ::= FindQuery | InsertQuery | UpdateQuery | RemoveQuery
FindQuery ::= FindClause [WhereClause] [MapClause] [...

Creating Queries
From the DocumentManager you can
execute DQL queries using the query()
method:
$users = $dm->query('find ...

Selecting Fields
$users = $dm->query('find username FROM User');
$users = $db->user->find(null, array('username'));

Paging Results
$users = $dm->query('find all FROM User limit 30 skip 30');
$users = $db->user->find();
$users->limit(30);
...

Selecting Embedded Slice
$post = $dm->query('find title, comments limit 20 skip 10 FROM
BlogPost WHERE id = ?', array($id)...

More Examples
// Find all posts greater than or equal to a date
$posts = $dm->query('find all FROM BlogPost WHERE createdA...

Events
Doctrine triggers events throughout the
lifecycle of objects it manages:
- preRemove
- postRemove
- prePersist
- po...

Maintaining Timestamps
/**
* @Document
* @HasLifecycleCallbacks
*/
class BlogPost
{
/** @Id */
public $id;
/** @Date */
pu...

Migrating Changes
Sometimes your documents change and
you will need to migrate your data.

Sample Scenario
Our original document looks like this:
/**
* @Document
*/
class User
{
/** @Id */
public $id;
/** @String ...

Renaming Fields
Later we want to store ﬁrst and last
names in separate ﬁelds:
/**
* @Document
*/
class User
{
/** @Id */
p...

Renaming Fields
Handle documents with only a name:
/**
* @Document
* @HasLifecycleCallbacks
*/
class User
{
/** @Id */
pub...

Why use an object
mapper?

Encapsulate your domain in an object oriented interface
Encapsulation

The organization of your domain logic in an OO way
improved maintainability
Maintainability

Keeping a clean OO domain model makes your business
logic easily testable for improved stability
Testability

Write portable and thin application controller code and
fat models.
Portability

Questions?
- http://www.twitter.com/jwage
- http://www.facebook.com/jwage
- http://www.jwage.com
OpenSky is hiring! Inquir...

Share Slideshare

LinkedIn
Facebook
Twitter

Embed

Size (px)

Show related Slideshows at end

WordPress Shortcode

Link

Share
Email

Symfony Day 2010 Doctrine MongoDB ODM by Jonathan Wage 4246 views
Doctrine MongoDB Object Document Ma... by Jonathan Wage 13039 views
My first zf presentation part two by isaaczfoster 834 views
Doctrine in the Real World by Jonathan Wage 5400 views
Symfony2 from the Trenches by Jonathan Wage 5440 views

View on Slideshare

1 of 86 Ad

View on Slideshare

1 of 86 Ad