At this point, you may be familiar with the design of MongoDB databases and collections – but what are the frequent patterns you may have to model?
This presentation will add knowledge of how to represent common relationships (1-1, 1-N, N-N) in MongoDB. Going further than relationships, this presentation identifies a set of common patterns, in a similar way to what the Gang of Four did for Object Oriented Design. Finally, this presentation will guide you through the steps of modeling those patterns in MongoDB collections.
In this session, you will learn about:
How to create the appropriate MongoDB collections for some of the patterns discussed.
Differences in relationships vs. the relational database world, and how those differences translate to MongoDB collections.
Common patterns in developing applications with MongoDB, plus a specific vocabulary with which to refer to them.
4. Why This Talk?
Over ten years with the
document model
Use of a common methodology
and vocabulary when designing
schemas for MongoDB
Ability to model schemas using
building blocks
Less art and more methodology
5. Pattern
The "Gang of Four":
A design pattern systematically
names, explains, and evaluates
an important and recurring design
in object-oriented systems
MongoDB systems can also be
built using its own patterns
6. Why Do We Create
Models?
Ensure:
• Good performance
• Scalability
despite constraints
Hardware
• RAM faster than Disk
• Disk cheaper than RAM
• Network latency
• Reduce costs $$$
Database Server
• Maximum size for a document
• Atomicity of a write
Data set
• Size of data
8. WMDB -
World Movie Database
Any events, characters and
entities depicted in this
presentation are fictional.
Any resemblance or similarity
to reality is entirely
coincidental
9. WMDB -
World Movie Database
First iteration
3 collections:
A. movies
B. moviegoers
C.screenings
10. Our mission, should we decide to accept it,
is to fix this solution, so it can perform well
and scale.
As always, should I or anyone in the
audience do it without training, WMDB will
disavow any knowledge of our actions.
This tape will self-destruct in five seconds.
Good luck!
Mission Possible
15. Problem:
Lots of similar fields
Common characteristic to search across those fields together
Fields present in only a small subset of documents
Use cases:
Product attributes like ‘color’, ‘size’, ‘dimensions’, ...
Release dates of a movie in different countries, festivals
Attribute Pattern
16. Solution:
Field pairs in an array
Benefits:
Allow for non deterministic list of attributes
Easy to index
{ "releases.location": 1, "releases.date": 1 }
Easy to extend with a qualifier, for example:
{ descriptor: "price", qualifier: "euros", value: Decimal(100.00) }
Attribute Pattern - Solution
17. Possible solutions:
A. Reduce the size of your working set
B. Add more RAM per machine
C. Start sharding or add more shards
Issue #2: Working Set Doesn’t Fit in
RAM
19. WMDB -
World Movie Database
First iteration
3 collections:
A. movies
B. moviegoers
C.screenings
20. In this example, we can:
Limit the list of actors and
crew to 20
Limit the embedded reviews
to the top 20
…
Pattern #2: Subset
21. Solution:
Keep duplicates of a small subset of fields in the main collection
Benefits:
Allows for fast data retrieval and a reduced working set size
One query brings all the information needed for the "main page"
Subset Pattern - Solution
22. Question:
Which MongoDB feature introduced in version 3.6 will allow me to
notify an application if the name of an actor is changed?
Quiz A
Subset Pattern
24. {
title: "The Shape of Water",
...
viewings: 5,000
viewers: 385,000
revenues: 5,074,800
}
Issue #3: ...caused by repeated
calculations
25. For example:
Apply a sum, count, ...
rollup data by minute, hour,
day
As long as you don’t mess
with your source, you can
recreate the rollups
Pattern #3: Computed
26. Problem:
There is data that needs to be computed
The same calculations would happen over and over
Reads outnumber writes:
• example: 1K writes per hour vs 1M read per hour
Use cases:
Have revenues per movie showing, want to display sums
Time series data, Event Sourcing
Computed Pattern
27. Solution:
Apply a computation or operation on data and store the result
Benefits:
Avoid re-computing the same thing over and over
Computed Pattern - Solution
33. Problem:
Data is difficult to calculate correctly
May be too expensive to update the document every time to keep
an exact count
Exactness of count may not be of high concern
Use cases:
Population of a country
Web site visits
Approximation Pattern
35. Keeping track of the schema version of a document
Issue #5: Need to Change the List
of Fields in the Documents
36. Add a field to track the
schema version number, per
document
Does not have to exist for
version 1
Pattern #5: Schema Versioning
37. Problem:
Updating the schema of a database is:
• Not atomic
• Long operation
• May not want to update all documents, only do it on updates
Use cases:
Practically any database that will go to production
Schema Versioning Pattern
38. Solution:
Have a field keeping track of the schema version
Benefits:
Don't need to update all the documents at once
May not have to update documents until their next modification
Schema Versioning Pattern –
Solution
40. How duplication is handled
A. Update both source and target in real time
B. Update target from source at regular intervals. Examples:
• Most popular items => update nightly
• Revenues from a movie => update every hour
• Last 10 reviews => update hourly? daily?
Aspect of Patterns: Consistency
41. What our Patterns did for us
Problem Pattern
Messy and Large Documents Attribute
Too much RAM Subset
Too much CPU Computed
Too many disk accesses Approximation
No downtime to upgrade schema Schema Versioning
42. • Bucket
• Grouping documents together, to have less documents
• Document Versioning
• Tracking of content changes in a document
• Outlier
• Avoid few documents driving the design and impact performance for
all
• External Reference
• Tree(s)
• Polymorphism
• Pre-allocation
Other Patterns
43. A. Simple grouping from tables to collections is not optimal
B. Learn a common vocabulary for designing schemas with MongoDB
C. Use patterns as "plug-and-play" to improve performance
Takeaways
44. A full design example for a
given problem:
E-commerce site
Contents Management
System
Social Networking
Single view
…
References for complete Solutions
45. More patterns in a follow up to this presentation
MongoDB in-person training courses on Schema Design
MongoDB Building With Patterns Blog series
Upcoming Online course at
MongoDB University:
• https://university.mongodb.com
• Data Modeling
How Can I Learn More About
Schema Design?
46. Question:
Which Pattern is used in the
following document?
{ "name": "Ken W. Alger",
"jobs_at_MongoDB": [
{ "job": "Developer Advocate",
"from": new Date("2018-07") }
],
"previous_jobs": [
"Production Manager",
"Executive Chef",
"Congressional Assistant",
"Entrepenuer”
],
"likes": [ "food", "beers", "movies", "MongoDB" ],
"email": "ken.alger@mongodb.com"
}
Quiz C
Which Pattern is used
Welcome
May not have time for questions, however come see me at the end
10 Years, Vocabulary, Building Blocks, "Art", => Why create models?
We use this content in our internal trainings.
The goal is not to teach you about doing schema design.
I am expecting you to either have done some with MongoDB or with a Relational Database
My goal is to help you formalize the process of creating schemas for MongoDB, help you work in a team by sharing visuals, vocabulary
Building blocks, Some patterns, => Same for MongoDB
Basically the ones who wrote this book on "Design Patterns"
GOF are Erich Gamma, Richard Helm, Ralph Johnson and John Vlissides
https://en.wikipedia.org/wiki/Design_Patterns
Key words are "Elements of Reusable Software"
Assemble their experience on designing and implementing software over the years
They found that a lot of the solutions were sharing some "patterns"
Examples of patterns from "Design Patterns"
Types: Creational (5), Structural (7), Behavioral (11)
Singleton (restrict the creation to a single object for a given class)
Observer (number of objects to see an event)
Command (user operation)
Decorator (embellishing a UI element)
Memento (ability to restore an object to a previous state)
…
So, they went and made a catalog of those "patterns".
The idea is enable people who write software to share a common language and have building blocks for solutions.
Performance & scalability, "air"
Before we get going, let's just answer why we create models.
In a perfect world, you don't really have to model.
I mean if everything is super fast and resources are abundant, you really don't care where and how data is stored
Every day I get up I don't make plans on how I will breathe air.
However if you go to space or under water, you will need a "design" that will let you get the amount of air you need.
Design is optional, cost of developer, 5 or 10 shards
If performance is not an issue, meaning you have resources to spare, then you are likely to model for simplicity. The reason is that software engineers are very expensive. You may not think so, but your manager does.
If you need to shard the database, it is likely that performance is very important
Why using 10 shards, if you can reduce the number of operations (reads and writes) by 2 and be able to do the same with 5 shards?
Fictional site, Entities
In order to illustrate this talk, let's assume there is a fictional site called the "World Movie Database".
This site is so popular that everyone goes there on Thursdays before the release of new movies and it crashes the site.
Then some people tried to migrate the site to a NoSQL database, MongoDB obviously.
Collections, grouping not optimal => accept challenge
This is the first try of trying to move the schema from Relational to MongoDB.
There are 3 collections: movies, moviegoers and screenings.
Simply grouping entities into collections is not optimal.
The solution using this design did not perform much better than the previous one.
This is still normalized. When you remove this restriction, duplication is fine, 1-1 relationships are fine.
You open the door to some important transformations.
Those will be our patterns.
[NOTE] Use "Sync Visibility" once you activate the color layer to also see it in the PNG file.
Perform & Scale, without training
Our goal, no need to say, is to fix this website before it gets the same fate as this tape recorder.
Some heroes need a lot of gadgets to achieve their mission. We will do our with a very powerfull one, patterns.
Categories, top 5 most frequent patterns
We will use patterns, like the Gang of Four.
Most patterns can be grouped in 3 categories.
We will cover those patterns identified with check marks in this presentation.
Also, I will cover the patterns in order of importance, or so.
For the other ones, I will refer you to the slides of this presentation and subsequent content we will have on the subject.
Documents are too big
How do I search on movies being released on a given date in the USA?
The same would apply to products you could see on E-commerce site.
For example, clothes may have a size that is expressed as S, M, L, while for some other products like a laptop, size would be something like 13", 15"
Inventory of things to insure
Polymorphic entities
Vehicles: submarine, car
"Adding a qualifier on the attribute" may be "currency"
Definition of Working set
With everyone pounding on the WMDB site, it was observed that the working set does not fit in memory.
What can you do?
Looking at the design we see that we are putting all the actors and all reviews for a given movie in the main document
[TODO] Add a drawing showing what the working set is
Definition of Working set
Working set represents the total body of data that the application uses in the course of normal operation. Often this is a subset of the total data size, but the specific size of the working set depends on actual moment-to-moment use of the database.
If you run a query that requires MongoDB to scan every document in a collection, the working set will expand to include every document. Depending on physical memory size, this may cause documents in the working set to “page out,” or to be removed from physical memory by the operating system. The next time MongoDB needs to access these documents, MongoDB may incur a hard page fault.
For best performance, the majority of your active set should fit in RAM.
Remember this collection in the middle?
The collection "castandcrew" contains all the actors, but also the producers, costume makers, stunts, etc.
For this pattern to be worth it, it has to have a fair amount of information left aside.
Please come see us at the Education booth, we have prizes for people who will get the answers right
What causes the CPU to heat up?
As you may guess, people pay attention to the popularity of the movies.
So, metrics like "revenues" and "viewers" are really important.
In the current design, those numbers are calculated every time the page of a movie is displayed.
Let’s calculate those numbers once in a while and stick the results on the page instead.
Also refer to "Rolled up" as CQRS - Command Query Responsibility Segregation
Another thing that was observed with the current design is that trying to keep track of all page views of the site resulted in very poor performance. That was seen for both MMAPv1 and WT.
In MMAPv1, you get a lot of threads looking for the write lock.
While with WT, you get a lot of write conflicts that need to be retried.
One solution is to record "good enough" numbers. Is it important that the count is 525 million or 525,00,234. What is the tolerance level here? Let’s assume 1000.
In this case, we will let the application update the page views by 1000, however only 1/1000th of the time. Statistically, we should get a result very close to the exact count, however doing only 1/1000th of the writes.
If you make the parallel to a movie, we never see a movie as a continuous image, the movie is made by displaying 24 static images per second, however this is enough to our eyes to not see the discontinuties.
How do you do that? Let’s have the application run a (X mod 1000) operation, where X is a random number. If the result is 0, let’s update the counter by 1000.
Another thing that was observed with the current design is that trying to keep track of all page views of the site resulted in very poor performance. That was seen for both MMAPv1 and WT.
In MMAPv1, you get a lot of threads looking for the write lock.
While with WT, you get a lot of write conflicts that need to be retried.
One solution is to record "good enough" numbers. Well no one cares that the count is 100 millions or 100 millions and few. What is the tolerance level here? Let’s assume 1000.
In this case, we will let the application update the page views by 1000, however only 1/1000th of the time. Statistically, we should get a result very close to the exact count, however doing only 1/1000th of the writes.
If you make the parallel to a movie, we never see a movie as a continuous image, the movie is made by displaying 24 static images per second, however this is enough to our eyes to not see the discontinuities.
How do you do that? Let’s have the application run a (X mod 1000) operation, where X is a random number. If the result is 0, let’s update the counter by 1000.
You can have a counter. Once you reach the count, you do the write.
Or you can use a random generator and when you get a specific value, you do the write.
As you might guess, this simple pattern is also applicable to Relational databases.
… it is just that NoSQL people have more tricks to handle performance bottlenecks.
Let's face it configuration management and database usually don't work well together.
Database tend to keep the "latest" state of your data, while "CM" systems remember everything. Those of us who checked in stupid mistakes in Git, ClearCase, etc know CM systems have a very long memory.
For this pattern, we are keeping track of the shape of the document. We are not addressing keeping track of the different contents of the document itself. This other case is solved by the Document Versioning pattern.
Instead of using a "version" field, we could discover the version number based on fields
- Few million references would not even fit into an embedded array. And if it did, you would not want to construct a query by passing a million values to the $in operator.
MongoDB has been around for many years. We wish we could have gone in the future a few years ago and see how people use our database. That did not happen.
However, now we know better how people are designing with MongoDB. We are able to identify patterns because we have seen a lot of models. Those are "plug-and-play" elements that let you go faster in your designs.
While we are on the subject of the future, I do believe MongoDB has a bright future.
Most data that could be put in a Relational Database is already there. We are left with:
Data this is "not square", meaning it does not fit well in square tables.
Large datasets
We believe the document model and the scalability of MongoDB are prime to store those data sets.
Ensure you are ready for the future by becoming an expert on MongoDB and how to model for it
We did use a fictional site, however all the patterns we used would also apply to "Internet of Things", "Single View", "E-commerce" solutions.
Let’s pause from our pattern list, and let’s examine a characteristic or aspect of some patterns.
The bucket pattern lets you group X sub-documents into one document. When the bucket is full, you create another one.
Pre-allocation will be the case where you pre-create an array of cells to have the reads and writes easily access the elements. This is a very important pattern if you are using MMAPv1, as continuously growing an array can have a negative effect. With Wired Tiger it is not as crucial, however may make the code in the application simpler.
As for Trees, they are commonly represented by either having one node per document, where you can list the parent, the children, the ancestors, or a combination of those
10 years of experience, building schema with the document model
You may not know about all the solutions, however we collected those over our 10 years of working with customers.
If you follow this advice, good things will happen.
Armed with those patterns, you may fell like a SuperHero, more powerful
My goal was to introduce you to patterns, however if you want more complete solutions to common problems, there are few good books out there. Let me point you to those 2:
The Little Mongo DB Schema Design Book Paperback, by Christian Kvalheim
MongoDB Applied Design Patterns, by Rick Copeland