1. Morphia
Simplifying Persistence for Java and MongoDB
Jeff Yemin

2. Outline
• MongoDB
• MongoDB on the JVM
• Morphia by Example
– Model
– Test
– Output

3. MongoDB
• Document-oriented storage
– JSON-style documents
• Rich, document-based queries
• Full index support
• Fast in-place updates
• Convenient Javascript shell
• Customer drivers for all major language

4. MongoDB on the JVM
• MongoDB Java Driver
– Map-based API
• JVM language integrations
– Casbah (Scala)
– Jmongo (Ruby)
– Monger (Clojure)
• ODM (Object Document Mapper)
– Morphia
– Spring Data MongoDB

5. Morphia
• Object Document Mapper
– Specifed with annotations
– Implemented with reflection
• Fluent query and update APIs
– Runtime validation

6. Dependencies
<dependency>
<groupId>org.mongodb</groupId>
<artifactId>mongo-java-driver</artifactId>
<version>2.8.0</version>
</dependency>
<dependency>
<groupId>com.google.code.morphia</groupId>
<artifactId>morphia</artifactId>
<version>0.99</version>
</dependency>

7. Repository
<repository>
<id>morphia</id>
<name>Morphia</name>
<url>http://morphia.googlecode.com/svn/mavenrepo/</url>
<layout>default</layout>
</repository>

8. Create the Datastore
Morphia morphia = new Morphia();
Mongo mongo = new Mongo();
Datastore ds = morphia.createDatastore(mongo, "test");

9. Let's model github

10. First Entity (model)
class Programmer {
String name;
}

11. First Entity (test)
Programmer programmer = new Programmer();
programmer.name= "Scott Hernandez";
ds.save(programmer);

12. First Entity (shell)
> db.Programmer.findOne()
{
"_id" : ObjectId("503292d51aa814c051554696"),
"className" : "demo.Programmer",
"name" : "Scott Hernandez"
}

13. @Id (model)
class Programmer {
@Id ObjectId id;
String name;
public void toString() {…}
}

14. @Id (test)
Programmer programmer = new Programmer();
programmer.name= "Scott Hernandez";
ds.save(programmer);
System.out.println(programmer)

15. @Id (toString)
Programmer{id=5032935f1aa8a8aa3485b441,
name='Scott Hernandez'}

16. String Id (model)
class Programmer {
@Id String githubUserName;
String name;
}

17. String Id (test)
Programmer programmer = new Programmer();
programmer.githubUserName = "scotthernandez";
programmer.name= "Scott Hernandez";
ds.save(programmer);

18. String Id (shell)
> db.Programmer.findOne()
{
"_id" : "scotthernandez",
"className" : "demo.Programmer",
"name" : "Scott Hernandez"
}

19. @Entity (model)
@Entity("programmers")
class Programmer {
@Id String githubUserName;
String name;
}

20. @Entity (shell)
> db.programmers.findOne()
{
"_id" : "scotthernandez",
"className" : "demo.Programmer",
"name" : "Scott Hernandez"
}

21. More primitives (model)
@Entity("programmers")
class Programmer {
@Id String githubUserName;
String name;
Date memberSince;
boolean active;
int followers;
}

22. More primitives (test)
Programmer scott = new Programmer();
scott.userName = "scotthernandez";
scott.name = "Scott Hernandez";
scott.since = dateFmt.parse("Aug 12, 2009");
scott.active = true;
scott.followers = 8;
ds.save(scott);

23. More primitives (shell)
> db.programmers.findOne()
{
"_id" : "scotthernandez",
"className" : "demo.Programmer",
"name" : "Scott Hernandez",
"memberSince" : ISODate("2009-08-12T04:00:00Z"),
"active" : true,
"followers" : 8
}

24. Primitive Array (Model)
@Entity("programmers")
class Programmer {
@Id String githubUserName;
String name;
Date memberSince;
boolean active;
int followers;
List<String> following;
}

25. Primitive Array (test)
Programmer scott = new Programmer();
scott.userName = "scotthernandez";
scott.name = "Scott Hernandez";
scott.since = dateFmt.parse("Aug 12, 2009");
scott.active = true;
scott.followers = 8;
scott.following = Arrays.asList("moraes", "stickfigure");
ds.save(scott);

26. Primitive Array (shell)
db.programmers.findOne()
{
"_id" : "scotthernandez",
"className" : "demo.Programmer",
"name" : "Scott Hernandez",
"memberSince" : ISODate("2009-08-12T04:00:00Z"),
"active" : true,
"followers" : 8,
"following" : [
"moraes",
"stickfigure"
]
}

27. @Embedded (model)
@Entity("programmers")
class Programmer {
@Id String githubUserName;
Name name;
Date memberSince;
boolean active;
int followers;
List<String> following;
}
@Embedded
class Name {
String first, last;
}

28. @Embedded (test)
Programmer programmer = new Programmer();
programmer.githubUserName = "scotthernandez";
programmer.name = new Name("Scott", "Hernandez");
programmer.memberSince = dateFmt.parse("Aug 12, 2009");
programmer.active = true;
programmer.followers = 8;
programmer.following = Arrays.asList("moraes", "stickfigure");
ds.save(programmer);

29. @Embedded (shell)
> db.programmers.findOne()
{
"_id" : "scotthernandez",
"className" : "demo.Programmer",
"name" : {
"first" : "Scott",
"last" : "Hernandez"
},
"memberSince" : ISODate("2009-08-12T04:00:00Z"),
"active" : true,
"followers" : 8,
"following" : [
"moraes",
"stickfigure"
]
}

30. @Embedded List (model)
@Entity("programmers")
class Programmer {
@Id String githubUserName;
Name name;
Date memberSince;
boolean active;
int followers;
List<String> following;
List<Repository> repositories;
}
@Embedded
class Name {
String first, last;
}
@Embedded
class Repository {
String name;
String forkedFrom;
}

31. @Embedded (test)
Programmer programmer = new Programmer();
programmer.githubUserName = "scotthernandez";
programmer.name = new Name("Scott", "Hernandez");
programmer.memberSince = dateFmt.parse("Aug 12, 2009");
programmer.active = true;
programmer.followers = 8;
programmer.following = Arrays.asList("moraes", "stickfigure");
programmer.repositories = Arrays.asList(
new Repository("docs", "mongodb/docs"),
new Repository("mongo-java-driver", "mongodb/mongo-java-driver"));
ds.save(programmer);

32. @Embedded List (shell)
> db.programmers.findOne()
{
"_id" : "scotthernandez",
"className" : "demo.Programmer",
…
"repositories" : [
{
"name" : "docs",
"forkedFrom" : "mongodb/docs"
},
{
"name" : "mongo-java-driver",
"forkedFrom" : "mongodb/mongo-java-driver"
}
]
}

33. @Reference (model)
@Entity("repos")
class Repository {
@Id ObjectId id;
@Reference Programmer owner;
String name;
String forkedFrom;
}

34. @Reference (test)
Programmer programmer = new Programmer();
programmer.githubUserName = "scotthernandez";
programmer.name = new Name("Scott", "Hernandez");
programmer.memberSince = dateFmt.parse("Aug 12, 2009");
programmer.active = true;
programmer.followers = 8;
programmer.following = Arrays.asList("moraes", "stickfigure");
ds.save(programmer);
Repository repo = new Repository(programmer, "docs",
"mongodb/docs");
ds.save(repo);

35. @Reference (shell)
> db.repos.findOne()
{
"_id" : ObjectId("503297e31aa8255abe542aaa"),
"className" : "demo.Repository",
"owner" : DBRef("programmers", "scotthernandez"),
"name" : "docs",
"forkedFrom" : "mongodb/docs"
}

36. Small schema change (model)
abstract class Member {
@Id String userName;
@Property("memberSince") Date since;
boolean active;
String name;
}
@Entity("programmers")
class Programmer extends Member {
int followers;
List<String> following;
}
@Entity("orgs")
class Organization extends Member {
}
@Entity("repos")
class Repository {
@Id ObjectId id;
@Reference Member owner;
String name;
@Reference(lazy=true) Repository forkedFrom;
}

37. Small schema change (test)
Programmer scott = new Programmer();
//…
ds.save(scott);
// save mongodb Organization
Organization mongodb = new Organization("mongodb",
"mongodb", sdf.parse("Jan 8, 2009"));
ds.save(mongodb);
// save mongodb's docs Repository
Repository mongoDocs = new Repository(mongodb, "docs");
ds.save(mongoDocs);
// save Scott's forked docs Repository
Repository scottDocs = new Repository(scott, "docs",
mongoDocs);
ds.save(scottDocs);

38. Small schema change (shell)
> db.orgs.findOne()
{
"_id" : "mongodb",
"className" : "demo.Organization",
"memberSince" : ISODate("2009-01-08T05:00:00Z"),
"active" : false,
"name" : "mongodb"
}
> db.programmers.findOne()
{
"_id" : "scotthernandez",
"className" : "demo.Programmer",
"memberSince" : ISODate("2009-08-12T04:00:00Z"),
"active" : true,
"name" : "Scott Hernandez"
…
}

39. Small schema change (shell, 2)
> db.repos.find().toArray()
[
{
"_id" : ObjectId("503298be1aa8b1d255e5d45b"),
"className" : "demo.Repository",
"owner" : DBRef("orgs", "mongodb"),
"name" : "docs"
},
{
"_id" : ObjectId("503298be1aa8b1d255e5d45c"),
"className" : "demo.Repository",
"owner" : DBRef("programmers", "scotthernandez"),
"name" : "docs",
"forkedFrom" : DBRef("repos", ObjectId("503298be1aa8b1d255e5d45b"))
}
]

40. Find by Equality (test)
• ds.get(Programmer.class, "scotthernandez")
• ds.find(Programmer.class, "userName", "scotthernandez")
• ds.find(Programmer.class).field("userName").equal("scotthernandez")

41. Find by Equality (logs)
• test.programmers query: { _id: "scotthernandez" }
• test.programmers query: { _id: "scotthernandez" }
• test.programmers query: { _id: "scotthernandez" }

42. Find by Range (test)
• ds.find(Programmer.class).field("followers").greaterThan(0)
• ds.find(Programmer.class).filter("followers >", 0)
• ds.find(Programmer.class).field("since"). lessThan(sdf.parse("Jan 1, 2010"))

43. Find by Range (logs)
• test.programmers query: { followers: { $gt: 0 } }
• test.programmers query: { followers: { $gt: 0 } }
• test.programmers query: { memberSince: { $lt: new Date(1262322000000) } }

44. Combining conditions (test)
ds.find(Programmer.class).
field("since").lessThan(dateFmt.parse("Jan 1, 2010")).
field("followers").greaterThan(0)

45. Combining conditions (logs)
test.programmers query: {
memberSince: { $lt: new Date(1262322000000) },
followers: { $gt: 0 }
}

46. Find by Reference (test)
ds.find(Repository.class).field("owner").equal(scott)

47. Find by Reference (logs)
test.repos query: {
owner: { $ref: "programmers", $id: "scotthernandez" }
}

48. @Indexed
• Annotation for fields
– value (IndexDirection)
– name (String)
– unique (boolean)
– dropDups (boolean)
– background (boolean)
– sparse (boolean)
• Examples
– @Indexed(value=IndexDirection.ASC, name="followers") int followers;
– @Indexed @Reference(lazy = true) Repository forkedFrom;

49. @Indexes and @Index
• @Indexes: Annotation for types
– value (Index[])
• @Index
– value (String)
– Others same as @Indexed
• Examples
– @Indexes(@Index("since, -followers")) public class Programmer {…}

50. Updating with save (test)
Programmer jeff = createJeff();
ds.save(jeff);
// jeff is following scott, so increment
// scott's followers and re-save
Programmer scott = ds.get(Programmer.class,
"scotthernandez")
scott.followers++;
ds.save(scott);

51. Updating with save (logs)
update test.programmers
query: {
_id: "scotthernandez",
}
update: {
_id: "scotthernandez",
className: "demo.Programmer",
followers: 9,
following: [ "moraes", "stickfigure" ],
memberSince: new Date(1250049600000),
active: true,
name: "Scott Hernandez",
}

52. Updating with save (shell)
> db.programmers.findOne()
{
"_id" : "scotthernandez",
"className" : "demo.Programmer",
"followers" : 9,
"following" : [
"moraes",
"stickfigure"
],
"memberSince" : ISODate("2009-08-12T04:00:00Z"),
"active" : true,
"name" : "Scott Hernandez"
}

53. Optimistic Concurrency (model)
@Entity
public abstract class Member {
@Id String userName;
@Property("memberSince") Date since;
boolean active;
String name;
@Version Long version;
}

54. Optimistic Concurrency (logs)
update test.programmers
query: {
_id: "scotthernandez",
version: 1345497713173
}
update: {
_id: "scotthernandez",
className: "demo.Programmer",
followers: 9,
following: [ "moraes", "stickfigure" ],
memberSince: new Date(1250049600000),
active: true,
name: "Scott Hernandez",
version: 1345497718181
}

55. Optimistic Concurrency (shell)
> db.programmers.findOne()
{
"_id" : "scotthernandez",
"className" : "demo.Programmer",
"followers" : 9,
"following" : [
"moraes",
"stickfigure"
],
"memberSince" : ISODate("2009-08-12T04:00:00Z"),
"active" : true,
"name" : "Scott Hernandez",
"version" : NumberLong("1345497660444")
}

56. UpdateOperations (test)
Programmer jeff = createJeff();
ds.save(jeff);
// increment followers of scott by one
UpdateOperations<Programmer> incrementFollowing =
ds.createUpdateOperations(Programmer.class).
inc("followers", 1);
Query<Programmer> queryForScott =
ds.find(Programmer.class, "userName", "scotthernandez");
ds.update(queryForScott, incrementFollowing);

57. Web Resources
• Morphia home: http://code.google.com/p/morphia/
• Morphia user group:
https://groups.google.com/forum/?fromgroups#!forum/morphia
• Demo code: https://github.com/jyemin/morphia-demo
– Separate commit and tag for each slide, so you
can play along

58. Boston Resources
• MongoDB User Group: http://www.meetup.com/Boston-
MongoDB-User-Group/
• 10gen office hours: Monthly at Dog Patch (with yours truly)

59. MongoDB Boston
• October 23-24
– Oct 23: Workshops on Schema Design and Operations
– Oct 24: Conference talks
– Discount code: MUG10 for 10% off tickets
– Early bird prices end Sept. 24
– Submit a talk proposal at 10gen.com/talk-proposal
– URL: 10gen.com/events/mongodb-boston

60. Thanks!
• Jeff Yemin
– https://twitter.com/@jeffyemin
– jeff.yemin@10gen.com
– https://github.com/jyemin/