Complex Structures
When it comes to managing complex data structures, choosing the right pattern can significantly impact the efficiency and effectiveness of your app.
You can embed a map in another map to create an embedded map comprised of multiple, hierarchical levels. For more information, see MAP.
For example, consider a people collection that contains documents with the following schema:
Such a schema translates to a document with a nested map cars where each car can be arbitrarily large:
The previous approach results in slow replication performance as follows:
- In scenarios with a limited internet connection or exclusive use of Bluetooth Low Energy (LE) for syncing across connected peers, replicating documents that contain large amounts of data experiences a slowdown. For instance, relying solely on Bluetooth LE for a document of typical size results in a maximum replication rate of 20 KB per second. Consequently, a document of 250 KB or more may take 10 seconds or more to replicate for the first time between devices.
- A slow replication rate causes a loading spinner to display to your end users until the replication process completes.
The reason that a slow replication rate causes a loading spinner during the replication process is that the callback is unable to render the returned data.
The end‑to‑end replication process requires breaking down documents into smaller parts before syncing them across the mesh. Only once the client receives all the smaller parts and reconstructs them, is the document returned.
Instead of using a single document to encode all of your large datasets, use a series of smaller documents. For more information, see Good Pattern: Flat Models.
Documents that exceed 5 MB do not sync with other connected peers.
If a document exceeds 250 KB in size, stdout warning prints to the console.
Unless required for your particular use case and requirements, instead of opting for a deeply embedded map structure,
Ditto uses a combination of the collection name and the document ID to sync and query documents. Collections serve as an index for a set of related documents, allowing you to establish foreign relationships between them by referencing the document ID.
For example, consider a people collection and a cars collection:
In the previous example, each car has an owner — represented by the _id.ownerId field — which relates to the person's document ID.
Since the document _id is immutable, only use the flat model in situations where you have static identifiers within your foreign-key relationship. If you use the flat model
In the people collection:
In the cars collection: