[IOT Lab]: Suggestion - explain reference vs embedding when it comes to data model for Trip document type

[deborahc]

Below is a sample document for the Trip entity in the metadata container. It uses the embedding data model pattern to put information on all the trips inside the document for a trip. There is another entity type "Package" that has more detailed information about each package. The Trip entity has some commonly used information about the package (embed) but references the rest via the consignment id on the Package entity.

It would be good to explain how this design was chosen, and why it is appropriate for the application (e.g. which data access pattern in the Web app application does this benefit?) This is a classic "embed vs reference" choice to make in data modelling in Cosmos DB.

Trip entity: { "partitionKey": "WFSGFJXH1AB67X93T", "id": "8c0745bb-6aba-4ca0-91d3-1189c307fb50", "entityType": "Trip", "vin": "WFSGFJXH1AB67X93T", "consignmentId": "90c21caa-b7ef-48b7-9ffa-3e91efeea73e", "plannedTripDistance": 14.62, "location": "MI", "odometerBegin": 94048, "odometerEnd": 0, "temperatureSetting": 19, "tripStarted": "2019-10-20T04:47:07.3689769Z", "tripEnded": null, "status": "Active", "timestamp": "0001-01-01T00:00:00", "packages": [ { "packageId": "0663181b-9e0c-4d64-b895-d87185bc92b0", "storageTemperature": 30, "highValue": false }, { "packageId": "619f2c7b-b7ac-46ab-8158-b8d2031dd878", "storageTemperature": 31, "highValue": false }, { "packageId": "3504afe7-6b7f-45c1-bd71-0dfb3933ecaa", "storageTemperature": 34, "highValue": false }, { "packageId": "d767856e-a127-4383-81f8-054f5f157e0d", "storageTemperature": 29, "highValue": false }, { "packageId": "4c334ca2-b944-492d-9cac-273017082ee6", "storageTemperature": 39, "highValue": false }, { "packageId": "4804c8fc-cf7d-472c-978b-33c0192572a9", "storageTemperature": 23, "highValue": false }, { "packageId": "137a91b6-1150-450c-9c93-a434bdfe5054", "storageTemperature": 29, "highValue": false }, { "packageId": "5e87b1c6-954f-471b-a670-1ed73a598aa3", "storageTemperature": 27, "highValue": false }, { "packageId": "0376b9be-c6a5-46b2-9a35-1e59237f05fd", "storageTemperature": 21, "highValue": false }, { "packageId": "c339c985-6cd0-44e1-9bfc-82f2695f64d6", "storageTemperature": 25, "highValue": false }, { "packageId": "7df6a0a1-688e-473a-b4dd-1589249b70c3", "storageTemperature": 29, "highValue": false }, { "packageId": "acbb5445-b51b-49d5-9449-b9f90f48f0f1", "storageTemperature": 25, "highValue": false }, { "packageId": "618b1836-e694-41a0-8bc5-02d4cd08a7b2", "storageTemperature": 30, "highValue": false }, { "packageId": "22ae2fdb-62c2-4a10-bbb7-94a554488650", "storageTemperature": 28, "highValue": false }, { "packageId": "57646350-96b9-4a8f-afe6-ed07ef06158e", "storageTemperature": 39, "highValue": false }, { "packageId": "5be40db8-8db9-4abe-bac0-682e00528b0b", "storageTemperature": 36, "highValue": true }, { "packageId": "72adaa35-8472-47bf-8f85-9e9b5e643fbd", "storageTemperature": 34, "highValue": false }, { "packageId": "6754b47e-9aa5-405e-995d-ddbce876d00d", "storageTemperature": 31, "highValue": false }, { "packageId": "abac9335-d6a6-458f-bc98-73e872f54d03", "storageTemperature": 22, "highValue": false }, { "packageId": "70164dce-a866-44e9-8d62-760909fb2307", "storageTemperature": 25, "highValue": false }, { "packageId": "83316996-63fa-4f5a-befc-07d0aa31083e", "storageTemperature": 30, "highValue": false }, { "packageId": "178f9765-05f0-44d8-b7fc-f1f6b5728e2a", "storageTemperature": 34, "highValue": false }, { "packageId": "b9df01e3-77ce-4a57-91bb-1647226dbd44", "storageTemperature": 23, "highValue": false }, { "packageId": "e585e160-376c-4e93-99f4-cd89279a782f", "storageTemperature": 38, "highValue": false }, { "packageId": "f299400e-94c6-47a5-9342-ebfae3ebcd8e", "storageTemperature": 24, "highValue": false }, { "packageId": "3f04472c-c66c-49ab-a083-70ce60e3998f", "storageTemperature": 24, "highValue": false }, { "packageId": "f50b12d6-3936-476e-ad37-b49f55d87380", "storageTemperature": 31, "highValue": false }, { "packageId": "c9a5db4b-92b4-4d1d-999f-e1192d4df683", "storageTemperature": 37, "highValue": false }, { "packageId": "db1181e0-b6e6-4f10-9e94-c5a083d3ac97", "storageTemperature": 33, "highValue": false }, { "packageId": "4bfed3cd-ce34-4965-ab19-ed16c267203f", "storageTemperature": 31, "highValue": false }, { "packageId": "e0fff21f-0632-489a-bf90-b458c4986150", "storageTemperature": 24, "highValue": false }, { "packageId": "cd32950d-9012-45a6-bfef-85f50b6c80db", "storageTemperature": 26, "highValue": false }, { "packageId": "119a6a27-6116-41a3-91c1-aa59abab15a8", "storageTemperature": 29, "highValue": false }, { "packageId": "565869f4-7d3c-4ac4-a5e5-4a87930037e6", "storageTemperature": 26, "highValue": false }, { "packageId": "1efcb2f2-e3ec-4b9c-a247-1d82d1586ee9", "storageTemperature": 38, "highValue": false }, { "packageId": "e743d57e-786e-45e1-8f03-142c313f8683", "storageTemperature": 32, "highValue": false }, { "packageId": "ecfcd8bb-b8b7-4caa-a7c1-1c5a7e29466f", "storageTemperature": 30, "highValue": false }, { "packageId": "a82e9fd2-2196-489e-9656-7e61f56b8046", "storageTemperature": 32, "highValue": false }, { "packageId": "556529f7-12dc-47df-825d-8f3ab965e98a", "storageTemperature": 23, "highValue": false }, { "packageId": "5ef5c973-13c1-4edc-8b4c-96128a21d958", "storageTemperature": 38, "highValue": false }, { "packageId": "1afffa2c-95ec-486e-bb49-f5de904e2ac8", "storageTemperature": 23, "highValue": false }, { "packageId": "4f468541-c21c-48e0-9435-4fa591c9977d", "storageTemperature": 34, "highValue": false }, { "packageId": "4f33b319-186e-4239-8348-10f903040e21", "storageTemperature": 22, "highValue": false }, { "packageId": "f88523fa-3f9e-47b8-be24-17fddfae27c5", "storageTemperature": 26, "highValue": false }, { "packageId": "0a4ea47f-3d94-41bf-a5cb-8224ee447414", "storageTemperature": 24, "highValue": false }, { "packageId": "e15521c7-3303-4866-9311-15b6ebb75a3f", "storageTemperature": 34, "highValue": false }, { "packageId": "8a2f1f5d-5943-46c3-b07e-b56eb64f147d", "storageTemperature": 25, "highValue": false }, { "packageId": "5b0b40a7-6c58-47d5-a753-8023d1b9fdbc", "storageTemperature": 35, "highValue": false }, { "packageId": "1ef1c85d-65f6-444d-bf02-23a23321b57e", "storageTemperature": 37, "highValue": false }, { "packageId": "a1e605e7-d256-4e03-b25b-984b33fcf1a5", "storageTemperature": 29, "highValue": false }, { "packageId": "ee0d8014-ad47-4523-9860-a5c107df2428", "storageTemperature": 21, "highValue": false }, { "packageId": "86550da7-771b-40d2-a17f-85a62e6f28be", "storageTemperature": 30, "highValue": false }, { "packageId": "05cb03a2-dbc8-4e13-a5f5-b5f1a64988a1", "storageTemperature": 29, "highValue": false }, { "packageId": "21188656-0cee-47f7-875a-7ba780d0d87b", "storageTemperature": 34, "highValue": false }, { "packageId": "ec2b72c7-2433-469b-b976-34b7623b9403", "storageTemperature": 34, "highValue": false }, { "packageId": "d8bbd3e4-7471-426c-80ad-c45bb2a75ec8", "storageTemperature": 38, "highValue": false }, { "packageId": "7c8a77d0-f910-4d3e-8d42-657c063b0dba", "storageTemperature": 25, "highValue": false }, { "packageId": "328e43df-cc4c-48d7-909b-90a47319319d", "storageTemperature": 28, "highValue": false }, { "packageId": "d9e18c69-ff49-4803-822c-9f9b18a95724", "storageTemperature": 33, "highValue": false }, { "packageId": "67681fd2-43a6-4602-a407-f8ad511c5a41", "storageTemperature": 32, "highValue": false }, { "packageId": "999fac0a-1243-446f-adee-a014844f4ebf", "storageTemperature": 25, "highValue": false }, { "packageId": "6a6cd8c3-ccea-4f0b-a0e6-eaccc7f3aa02", "storageTemperature": 34, "highValue": false }, { "packageId": "6540acb1-8863-4b1c-8acd-0083b172a8cd", "storageTemperature": 37, "highValue": false }, { "packageId": "697c57bc-61d1-4413-b165-117704e7f2f0", "storageTemperature": 24, "highValue": true }, { "packageId": "4bb37be6-aad9-4d2b-9372-36d15f374982", "storageTemperature": 30, "highValue": false }, { "packageId": "c81fb9f2-dc54-490d-8b74-d0fb45160d40", "storageTemperature": 35, "highValue": false }, { "packageId": "d5f2fa31-6dd8-498d-8f89-0975b6f62f0f", "storageTemperature": 39, "highValue": false }, { "packageId": "5a9ef97c-1f3e-4fb8-8598-fd5a911ab715", "storageTemperature": 29, "highValue": false }, { "packageId": "aa5cdb04-a9c2-40c1-9a8b-80be574dfdd8", "storageTemperature": 34, "highValue": false }, { "packageId": "22fffbed-16b4-471e-88a0-acf90607cabe", "storageTemperature": 22, "highValue": false }, { "packageId": "6d441122-fd3b-4769-a60b-b3bf1c770b84", "storageTemperature": 37, "highValue": false }, { "packageId": "ff92b13a-67e8-4468-ab12-f7c3efb4a0da", "storageTemperature": 28, "highValue": false }, { "packageId": "02c9d6c6-7a3f-4237-aac9-98caf1c1a503", "storageTemperature": 32, "highValue": false }, { "packageId": "ec16a704-ba2a-4d9f-941f-689faa661e81", "storageTemperature": 35, "highValue": false }, { "packageId": "f09fc6e6-38a6-408e-b94e-979cbd9d2fa6", "storageTemperature": 29, "highValue": false }, { "packageId": "b692e07c-ab4b-4283-90fc-429cdb802307", "storageTemperature": 28, "highValue": false }, { "packageId": "4af5dddf-eaee-4e37-98ab-e7ed6f5d096f", "storageTemperature": 32, "highValue": false }, { "packageId": "637b3fd8-52e6-44e5-9728-01d6f23101ff", "storageTemperature": 35, "highValue": false }, { "packageId": "d40c8cc7-a0db-4598-9aa5-da64361788a4", "storageTemperature": 29, "highValue": false }, { "packageId": "079862bb-a876-4a48-b5c3-351b06c66998", "storageTemperature": 29, "highValue": false }, { "packageId": "c9f12cd7-5ef3-478b-9a14-26f5844dc3cf", "storageTemperature": 32, "highValue": false }, { "packageId": "e873f026-3690-4bb5-8217-88c2178cd098", "storageTemperature": 39, "highValue": false }, { "packageId": "25788e07-aa84-4610-ac6f-733eae36dfc6", "storageTemperature": 21, "highValue": false }, { "packageId": "4c335469-faff-437c-a986-9cedc4663f28", "storageTemperature": 21, "highValue": false }, { "packageId": "cb54dbd9-daf0-498f-af31-bef129340867", "storageTemperature": 31, "highValue": false }, { "packageId": "3560cef5-08fb-4e3b-a4ca-eabf2459d157", "storageTemperature": 29, "highValue": false }, { "packageId": "bbfac5c2-0dc6-4181-8d7a-0cbba0f589bb", "storageTemperature": 23, "highValue": false }, { "packageId": "baaf2c63-87a8-492d-bf1e-1999e9a31c29", "storageTemperature": 34, "highValue": false }, { "packageId": "a82b4eda-1460-42b8-a7b8-c0073169389e", "storageTemperature": 37, "highValue": false }, { "packageId": "302aa15f-f4d3-41b7-8fac-dec366ba49af", "storageTemperature": 33, "highValue": false }, { "packageId": "59317924-d87e-4930-bde6-6ad9d1351711", "storageTemperature": 23, "highValue": false }, { "packageId": "4ee3363a-ded0-4d79-ba38-d19fe5f558f9", "storageTemperature": 35, "highValue": false }, { "packageId": "acc37c7f-00e7-4eea-a43e-3736742630c6", "storageTemperature": 38, "highValue": false }, { "packageId": "390c9a8d-ef31-41ad-b7f2-2161c8e618c9", "storageTemperature": 28, "highValue": false }, { "packageId": "7fc34df6-bbce-475e-82f8-19d54141633b", "storageTemperature": 24, "highValue": true }, { "packageId": "1c9c0bf7-aeda-430e-9986-6c58c74006d5", "storageTemperature": 24, "highValue": false }, { "packageId": "bd17e8c3-cfc4-45af-8709-1bb1a6857853", "storageTemperature": 31, "highValue": false }, { "packageId": "083565e8-b048-46be-9d6a-8dd2563e2f00", "storageTemperature": 26, "highValue": false }, { "packageId": "a84206dc-ed1d-48e6-89a9-5b1e93a26f2a", "storageTemperature": 25, "highValue": false }, { "packageId": "dc34fd6f-4696-4dcc-b240-596ab6331bac", "storageTemperature": 25, "highValue": false }, { "packageId": "4582be30-0590-4ef8-a813-1c3758ac96af", "storageTemperature": 31, "highValue": false }, { "packageId": "790cf3fa-5146-4ed7-b451-1075090a4c0b", "storageTemperature": 28, "highValue": false }, { "packageId": "c245d71c-5958-4ea2-bd2e-02a60db83c35", "storageTemperature": 29, "highValue": false }, { "packageId": "0364dec7-c9c2-46ab-b865-7db989beb07d", "storageTemperature": 39, "highValue": false }, { "packageId": "edf7bcc4-04b3-44de-ac4f-4fdd729e0814", "storageTemperature": 26, "highValue": false }, { "packageId": "427bd734-265c-4940-a4ed-3ba3e07d9293", "storageTemperature": 28, "highValue": false }, { "packageId": "4540c99d-2a26-4400-ae9a-bca39c163e8f", "storageTemperature": 37, "highValue": false }, { "packageId": "b96673e5-4a41-4b1e-8622-043b314b7a32", "storageTemperature": 31, "highValue": false }, { "packageId": "cd022866-6df9-463e-8e99-b8cc15218b46", "storageTemperature": 38, "highValue": false }, { "packageId": "91049925-55b3-4c5b-9ed8-cfb5c86837a8", "storageTemperature": 32, "highValue": false }, { "packageId": "b25805a4-e17e-4df8-bc99-8531a42717ff", "storageTemperature": 23, "highValue": false }, { "packageId": "9e75a19b-5cee-4a24-9cc8-7a28411b4e28", "storageTemperature": 38, "highValue": false }, { "packageId": "efd1611a-b047-4d76-b200-6b159f168ac1", "storageTemperature": 22, "highValue": false } ], "consignment": { "consignmentId": "90c21caa-b7ef-48b7-9ffa-3e91efeea73e", "customer": "Consolidated Messenger", "deliveryDueDate": "2019-10-20T06:47:44.7367989Z" }, "_rid": "G-grAMMQRt29TAAAAAAAAA==", "_self": "dbs/G-grAA==/colls/G-grAMMQRt0=/docs/G-grAMMQRt29TAAAAAAAAA==/", "_etag": ""2700486e-0000-1a00-0000-5dabe6cb0000"", "_attachments": "attachments/", "_ts": 1571546827 }

Package entity: [ { "id": "ad476b94-8b3a-4ab8-ba5f-b95ad75acd63", "_rid": "G-grAMMQRt3JAAAAAAAAAA==", "_self": "dbs/G-grAA==/colls/G-grAMMQRt0=/docs/G-grAMMQRt3JAAAAAAAAAA==/", "_etag": ""2700f221-0000-1a00-0000-5dabe6800000"", "partitionKey": "cb56399c-65b3-452b-89f0-d3b9bed5fa02", "entityType": "Package", "tripId": "ed96feb9-957e-4d30-873e-7a4f12266022", "consignmentId": "cb56399c-65b3-452b-89f0-d3b9bed5fa02", "height": 33.37, "length": 41.45, "width": 20.96, "grossWeight": 223.72, "storageTemperature": 39, "highValue": false, "trip": { "tripId": "ed96feb9-957e-4d30-873e-7a4f12266022", "vin": "AESQX3ZKCFM25HNNE", "plannedTripDistance": 137.09 }, "consignment": { "consignmentId": "cb56399c-65b3-452b-89f0-d3b9bed5fa02", "customer": "Lamna Healthcare Company", "deliveryDueDate": "2019-10-20T08:26:44.7366267Z" }, "timestamp": "0001-01-01T00:00:00", "_attachments": "attachments/", "_ts": 1571546752 } ]