@mytechtoday/augment-extensions 0.7.0 → 1.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (483) hide show
  1. package/AGENTS.md +265 -232
  2. package/README.md +956 -771
  3. package/augment-extensions/coding-standards/bash/README.md +196 -196
  4. package/augment-extensions/coding-standards/bash/module.json +163 -163
  5. package/augment-extensions/coding-standards/bash/rules/naming-conventions.md +336 -336
  6. package/augment-extensions/coding-standards/bash/rules/universal-standards.md +289 -289
  7. package/augment-extensions/coding-standards/css/README.md +40 -40
  8. package/augment-extensions/coding-standards/css/examples/css-examples.css +550 -550
  9. package/augment-extensions/coding-standards/css/module.json +44 -44
  10. package/augment-extensions/coding-standards/css/rules/css-modern-features.md +448 -448
  11. package/augment-extensions/coding-standards/css/rules/css-standards.md +492 -492
  12. package/augment-extensions/coding-standards/html/README.md +40 -40
  13. package/augment-extensions/coding-standards/html/examples/html-examples.html +267 -267
  14. package/augment-extensions/coding-standards/html/examples/responsive-layout.html +505 -505
  15. package/augment-extensions/coding-standards/html/module.json +44 -44
  16. package/augment-extensions/coding-standards/html/rules/html-standards.md +349 -349
  17. package/augment-extensions/coding-standards/html-css-js/README.md +194 -194
  18. package/augment-extensions/coding-standards/html-css-js/examples/async-examples.js +487 -487
  19. package/augment-extensions/coding-standards/html-css-js/examples/css-examples.css +550 -550
  20. package/augment-extensions/coding-standards/html-css-js/examples/dom-examples.js +667 -667
  21. package/augment-extensions/coding-standards/html-css-js/examples/html-examples.html +267 -267
  22. package/augment-extensions/coding-standards/html-css-js/examples/javascript-examples.js +612 -612
  23. package/augment-extensions/coding-standards/html-css-js/examples/responsive-layout.html +505 -505
  24. package/augment-extensions/coding-standards/html-css-js/module.json +48 -48
  25. package/augment-extensions/coding-standards/html-css-js/rules/async-patterns.md +515 -515
  26. package/augment-extensions/coding-standards/html-css-js/rules/css-modern-features.md +448 -448
  27. package/augment-extensions/coding-standards/html-css-js/rules/css-standards.md +492 -492
  28. package/augment-extensions/coding-standards/html-css-js/rules/dom-manipulation.md +439 -439
  29. package/augment-extensions/coding-standards/html-css-js/rules/html-standards.md +349 -349
  30. package/augment-extensions/coding-standards/html-css-js/rules/javascript-standards.md +486 -486
  31. package/augment-extensions/coding-standards/html-css-js/rules/performance.md +463 -463
  32. package/augment-extensions/coding-standards/html-css-js/rules/tooling.md +543 -543
  33. package/augment-extensions/coding-standards/js/README.md +46 -46
  34. package/augment-extensions/coding-standards/js/examples/async-examples.js +487 -487
  35. package/augment-extensions/coding-standards/js/examples/dom-examples.js +667 -667
  36. package/augment-extensions/coding-standards/js/examples/javascript-examples.js +612 -612
  37. package/augment-extensions/coding-standards/js/module.json +49 -49
  38. package/augment-extensions/coding-standards/js/rules/async-patterns.md +515 -515
  39. package/augment-extensions/coding-standards/js/rules/dom-manipulation.md +439 -439
  40. package/augment-extensions/coding-standards/js/rules/javascript-standards.md +486 -486
  41. package/augment-extensions/coding-standards/js/rules/performance.md +463 -463
  42. package/augment-extensions/coding-standards/js/rules/tooling.md +543 -543
  43. package/augment-extensions/coding-standards/php/README.md +248 -248
  44. package/augment-extensions/coding-standards/php/examples/api-endpoint-example.php +204 -204
  45. package/augment-extensions/coding-standards/php/examples/cli-command-example.php +206 -206
  46. package/augment-extensions/coding-standards/php/examples/legacy-refactoring-example.php +234 -234
  47. package/augment-extensions/coding-standards/php/examples/web-application-example.php +211 -211
  48. package/augment-extensions/coding-standards/php/examples/woocommerce-extension-example.php +215 -215
  49. package/augment-extensions/coding-standards/php/examples/wordpress-plugin-example.php +189 -189
  50. package/augment-extensions/coding-standards/php/module.json +166 -166
  51. package/augment-extensions/coding-standards/php/rules/api-development.md +480 -480
  52. package/augment-extensions/coding-standards/php/rules/category-configuration.md +332 -332
  53. package/augment-extensions/coding-standards/php/rules/cli-tools.md +472 -472
  54. package/augment-extensions/coding-standards/php/rules/cms-integration.md +561 -561
  55. package/augment-extensions/coding-standards/php/rules/code-quality.md +402 -402
  56. package/augment-extensions/coding-standards/php/rules/documentation.md +425 -425
  57. package/augment-extensions/coding-standards/php/rules/ecommerce.md +627 -627
  58. package/augment-extensions/coding-standards/php/rules/error-handling.md +336 -336
  59. package/augment-extensions/coding-standards/php/rules/legacy-migration.md +677 -677
  60. package/augment-extensions/coding-standards/php/rules/naming-conventions.md +279 -279
  61. package/augment-extensions/coding-standards/php/rules/performance.md +392 -392
  62. package/augment-extensions/coding-standards/php/rules/psr-standards.md +186 -186
  63. package/augment-extensions/coding-standards/php/rules/security.md +358 -358
  64. package/augment-extensions/coding-standards/php/rules/testing.md +403 -403
  65. package/augment-extensions/coding-standards/php/rules/type-declarations.md +331 -331
  66. package/augment-extensions/coding-standards/php/rules/web-applications.md +426 -426
  67. package/augment-extensions/coding-standards/powershell/README.md +154 -154
  68. package/augment-extensions/coding-standards/powershell/examples/admin-example.ps1 +272 -272
  69. package/augment-extensions/coding-standards/powershell/examples/automation-example.ps1 +173 -173
  70. package/augment-extensions/coding-standards/powershell/examples/cloud-example.ps1 +243 -243
  71. package/augment-extensions/coding-standards/powershell/examples/cross-platform-example.ps1 +297 -297
  72. package/augment-extensions/coding-standards/powershell/examples/dsc-example.ps1 +224 -224
  73. package/augment-extensions/coding-standards/powershell/examples/legacy-migration-example.ps1 +340 -340
  74. package/augment-extensions/coding-standards/powershell/examples/module-example.psm1 +255 -255
  75. package/augment-extensions/coding-standards/powershell/module.json +165 -165
  76. package/augment-extensions/coding-standards/powershell/rules/administrative-tools.md +439 -439
  77. package/augment-extensions/coding-standards/powershell/rules/automation-scripts.md +240 -240
  78. package/augment-extensions/coding-standards/powershell/rules/cloud-orchestration.md +384 -384
  79. package/augment-extensions/coding-standards/powershell/rules/configuration-schema.md +383 -383
  80. package/augment-extensions/coding-standards/powershell/rules/cross-platform-scripts.md +482 -482
  81. package/augment-extensions/coding-standards/powershell/rules/dsc-configurations.md +296 -296
  82. package/augment-extensions/coding-standards/powershell/rules/error-handling.md +314 -314
  83. package/augment-extensions/coding-standards/powershell/rules/legacy-migrations.md +466 -466
  84. package/augment-extensions/coding-standards/powershell/rules/modules-functions.md +244 -244
  85. package/augment-extensions/coding-standards/powershell/rules/naming-conventions.md +266 -266
  86. package/augment-extensions/coding-standards/powershell/rules/performance-optimization.md +209 -209
  87. package/augment-extensions/coding-standards/powershell/rules/security-practices.md +314 -314
  88. package/augment-extensions/coding-standards/powershell/rules/testing-guidelines.md +268 -268
  89. package/augment-extensions/coding-standards/powershell/rules/universal-standards.md +197 -197
  90. package/augment-extensions/coding-standards/python/README.md +48 -48
  91. package/augment-extensions/coding-standards/python/examples/best-practices.py +373 -373
  92. package/augment-extensions/coding-standards/python/module.json +30 -30
  93. package/augment-extensions/coding-standards/python/rules/async-patterns.md +884 -884
  94. package/augment-extensions/coding-standards/python/rules/best-practices.md +232 -232
  95. package/augment-extensions/coding-standards/python/rules/code-organization.md +220 -220
  96. package/augment-extensions/coding-standards/python/rules/documentation.md +831 -831
  97. package/augment-extensions/coding-standards/python/rules/error-handling.md +1008 -1008
  98. package/augment-extensions/coding-standards/python/rules/naming-conventions.md +172 -172
  99. package/augment-extensions/coding-standards/python/rules/testing.md +409 -409
  100. package/augment-extensions/coding-standards/python/rules/tooling.md +446 -446
  101. package/augment-extensions/coding-standards/python/rules/type-hints.md +253 -253
  102. package/augment-extensions/coding-standards/react/README.md +45 -45
  103. package/augment-extensions/coding-standards/react/module.json +27 -27
  104. package/augment-extensions/coding-standards/react/rules/component-patterns.md +214 -214
  105. package/augment-extensions/coding-standards/react/rules/hooks-best-practices.md +235 -235
  106. package/augment-extensions/coding-standards/react/rules/performance.md +300 -300
  107. package/augment-extensions/coding-standards/react/rules/state-management.md +265 -265
  108. package/augment-extensions/coding-standards/react/rules/typescript-react.md +271 -271
  109. package/augment-extensions/coding-standards/typescript/README.md +45 -45
  110. package/augment-extensions/coding-standards/typescript/module.json +27 -27
  111. package/augment-extensions/coding-standards/typescript/rules/naming-conventions.md +225 -225
  112. package/augment-extensions/collections/html-css-js/README.md +82 -82
  113. package/augment-extensions/collections/html-css-js/collection.json +41 -41
  114. package/augment-extensions/domain-rules/api-design/README.md +41 -41
  115. package/augment-extensions/domain-rules/api-design/module.json +27 -27
  116. package/augment-extensions/domain-rules/api-design/rules/authentication.md +263 -263
  117. package/augment-extensions/domain-rules/api-design/rules/documentation.md +395 -395
  118. package/augment-extensions/domain-rules/api-design/rules/error-handling.md +290 -290
  119. package/augment-extensions/domain-rules/api-design/rules/graphql-api.md +313 -313
  120. package/augment-extensions/domain-rules/api-design/rules/rest-api.md +214 -214
  121. package/augment-extensions/domain-rules/api-design/rules/versioning.md +268 -268
  122. package/augment-extensions/domain-rules/database/README.md +161 -161
  123. package/augment-extensions/domain-rules/database/examples/flat-database-example.md +793 -793
  124. package/augment-extensions/domain-rules/database/examples/hybrid-database-example.md +1132 -1132
  125. package/augment-extensions/domain-rules/database/examples/nosql-document-example.md +868 -868
  126. package/augment-extensions/domain-rules/database/examples/nosql-graph-example.md +805 -805
  127. package/augment-extensions/domain-rules/database/examples/relational-schema-example.md +621 -621
  128. package/augment-extensions/domain-rules/database/examples/vector-database-example.md +965 -965
  129. package/augment-extensions/domain-rules/database/module.json +28 -28
  130. package/augment-extensions/domain-rules/database/rules/flat-databases.md +624 -624
  131. package/augment-extensions/domain-rules/database/rules/nosql-databases.md +588 -588
  132. package/augment-extensions/domain-rules/database/rules/nosql-document-stores.md +856 -856
  133. package/augment-extensions/domain-rules/database/rules/nosql-graph-databases.md +778 -778
  134. package/augment-extensions/domain-rules/database/rules/nosql-key-value-stores.md +963 -963
  135. package/augment-extensions/domain-rules/database/rules/performance-optimization.md +1076 -1076
  136. package/augment-extensions/domain-rules/database/rules/relational-databases.md +697 -697
  137. package/augment-extensions/domain-rules/database/rules/relational-indexing.md +671 -671
  138. package/augment-extensions/domain-rules/database/rules/relational-query-optimization.md +607 -607
  139. package/augment-extensions/domain-rules/database/rules/relational-schema-design.md +907 -907
  140. package/augment-extensions/domain-rules/database/rules/relational-transactions.md +783 -783
  141. package/augment-extensions/domain-rules/database/rules/security-standards.md +980 -980
  142. package/augment-extensions/domain-rules/database/rules/universal-best-practices.md +485 -485
  143. package/augment-extensions/domain-rules/database/rules/vector-databases.md +521 -521
  144. package/augment-extensions/domain-rules/database/rules/vector-embeddings.md +858 -858
  145. package/augment-extensions/domain-rules/database/rules/vector-indexing.md +934 -934
  146. package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/README.md +23 -23
  147. package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/module.json +26 -26
  148. package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/README.md +23 -23
  149. package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/module.json +26 -26
  150. package/augment-extensions/domain-rules/design/color/themes/dracula/README.md +23 -23
  151. package/augment-extensions/domain-rules/design/color/themes/dracula/module.json +26 -26
  152. package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/README.md +23 -23
  153. package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/module.json +26 -26
  154. package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/README.md +23 -23
  155. package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/module.json +26 -26
  156. package/augment-extensions/domain-rules/design/color/themes/high-contrast/README.md +27 -27
  157. package/augment-extensions/domain-rules/design/color/themes/high-contrast/module.json +26 -26
  158. package/augment-extensions/domain-rules/design/color/themes/monokai/README.md +23 -23
  159. package/augment-extensions/domain-rules/design/color/themes/monokai/module.json +26 -26
  160. package/augment-extensions/domain-rules/design/color/themes/nord/README.md +23 -23
  161. package/augment-extensions/domain-rules/design/color/themes/nord/module.json +26 -26
  162. package/augment-extensions/domain-rules/design/color/themes/one-dark/README.md +23 -23
  163. package/augment-extensions/domain-rules/design/color/themes/one-dark/module.json +26 -26
  164. package/augment-extensions/domain-rules/design/color/themes/one-light/README.md +23 -23
  165. package/augment-extensions/domain-rules/design/color/themes/one-light/module.json +26 -26
  166. package/augment-extensions/domain-rules/design/color/themes/solarized-dark/README.md +23 -23
  167. package/augment-extensions/domain-rules/design/color/themes/solarized-dark/module.json +26 -26
  168. package/augment-extensions/domain-rules/design/color/themes/solarized-light/README.md +23 -23
  169. package/augment-extensions/domain-rules/design/color/themes/solarized-light/module.json +26 -26
  170. package/augment-extensions/domain-rules/design/color/themes/tokyo-night/README.md +23 -23
  171. package/augment-extensions/domain-rules/design/color/themes/tokyo-night/module.json +26 -26
  172. package/augment-extensions/domain-rules/mcp/README.md +150 -150
  173. package/augment-extensions/domain-rules/mcp/examples/compressed-example.md +522 -522
  174. package/augment-extensions/domain-rules/mcp/examples/graph-augmented-example.md +520 -520
  175. package/augment-extensions/domain-rules/mcp/examples/hybrid-example.md +570 -570
  176. package/augment-extensions/domain-rules/mcp/examples/state-based-example.md +427 -427
  177. package/augment-extensions/domain-rules/mcp/examples/token-based-example.md +435 -435
  178. package/augment-extensions/domain-rules/mcp/examples/vector-based-example.md +502 -502
  179. package/augment-extensions/domain-rules/mcp/module.json +49 -49
  180. package/augment-extensions/domain-rules/mcp/rules/compressed-mcp.md +595 -595
  181. package/augment-extensions/domain-rules/mcp/rules/configuration.md +345 -345
  182. package/augment-extensions/domain-rules/mcp/rules/graph-augmented-mcp.md +687 -687
  183. package/augment-extensions/domain-rules/mcp/rules/hybrid-mcp.md +636 -636
  184. package/augment-extensions/domain-rules/mcp/rules/state-based-mcp.md +484 -484
  185. package/augment-extensions/domain-rules/mcp/rules/testing-validation.md +360 -360
  186. package/augment-extensions/domain-rules/mcp/rules/token-based-mcp.md +393 -393
  187. package/augment-extensions/domain-rules/mcp/rules/universal-rules.md +194 -194
  188. package/augment-extensions/domain-rules/mcp/rules/vector-based-mcp.md +625 -625
  189. package/augment-extensions/domain-rules/security/README.md +41 -41
  190. package/augment-extensions/domain-rules/security/module.json +28 -28
  191. package/augment-extensions/domain-rules/security/rules/authentication-security.md +361 -361
  192. package/augment-extensions/domain-rules/security/rules/encryption.md +208 -208
  193. package/augment-extensions/domain-rules/security/rules/input-validation.md +294 -294
  194. package/augment-extensions/domain-rules/security/rules/owasp-top-10.md +339 -339
  195. package/augment-extensions/domain-rules/security/rules/secure-coding.md +293 -293
  196. package/augment-extensions/domain-rules/security/rules/web-security.md +268 -268
  197. package/augment-extensions/domain-rules/seo-sales-marketing/ANNOUNCEMENT.md +143 -0
  198. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/README.md +140 -136
  199. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/SCHEMA-VALIDATION-REPORT.md +216 -216
  200. package/augment-extensions/domain-rules/seo-sales-marketing/TEST-VALIDATION.md +129 -0
  201. package/augment-extensions/domain-rules/seo-sales-marketing/USAGE-GUIDES.md +254 -0
  202. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/brand-kit-example.yaml +292 -292
  203. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/campaign-brief-example.yaml +389 -389
  204. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/content-calendar-example.yaml +643 -643
  205. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/email-newsletter-example.md +376 -376
  206. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/landing-page-example.md +934 -934
  207. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/ppc-ad-copy-example.md +301 -301
  208. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/seo-blog-post-example.md +347 -347
  209. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/social-media-campaign-example.md +606 -606
  210. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/module.json +50 -50
  211. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/affiliate-influencer-marketing.md +593 -593
  212. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/asset-management.md +418 -418
  213. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/brand-consistency.md +210 -210
  214. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/content-marketing.md +337 -337
  215. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/conversion-optimization.md +455 -455
  216. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/direct-sales.md +499 -499
  217. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/email-marketing.md +439 -439
  218. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/legal-compliance.md +227 -227
  219. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/ppc-advertising.md +569 -569
  220. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/seo-optimization.md +470 -470
  221. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/social-media-marketing.md +414 -414
  222. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/universal-marketing.md +177 -177
  223. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/asset-inventory.schema.json +247 -247
  224. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/brand-kit.schema.json +326 -326
  225. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/campaign-brief.schema.json +342 -342
  226. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/color-palette.schema.json +223 -223
  227. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/content-template.schema.json +383 -383
  228. package/augment-extensions/domain-rules/wordpress/README.md +163 -163
  229. package/augment-extensions/domain-rules/wordpress/module.json +32 -32
  230. package/augment-extensions/domain-rules/wordpress/rules/coding-standards.md +617 -617
  231. package/augment-extensions/domain-rules/wordpress/rules/directory-structure.md +270 -270
  232. package/augment-extensions/domain-rules/wordpress/rules/file-patterns.md +423 -423
  233. package/augment-extensions/domain-rules/wordpress/rules/gutenberg-blocks.md +493 -493
  234. package/augment-extensions/domain-rules/wordpress/rules/performance.md +568 -568
  235. package/augment-extensions/domain-rules/wordpress/rules/plugin-development.md +510 -510
  236. package/augment-extensions/domain-rules/wordpress/rules/project-detection.md +251 -251
  237. package/augment-extensions/domain-rules/wordpress/rules/rest-api.md +501 -501
  238. package/augment-extensions/domain-rules/wordpress/rules/security.md +564 -564
  239. package/augment-extensions/domain-rules/wordpress/rules/theme-development.md +388 -388
  240. package/augment-extensions/domain-rules/wordpress/rules/woocommerce.md +441 -441
  241. package/augment-extensions/domain-rules/wordpress-plugin/README.md +139 -139
  242. package/augment-extensions/domain-rules/wordpress-plugin/examples/ajax-plugin.md +1599 -1599
  243. package/augment-extensions/domain-rules/wordpress-plugin/examples/custom-post-type-plugin.md +1727 -1727
  244. package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block-plugin.md +428 -428
  245. package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block.md +422 -422
  246. package/augment-extensions/domain-rules/wordpress-plugin/examples/mvc-plugin.md +1623 -1623
  247. package/augment-extensions/domain-rules/wordpress-plugin/examples/object-oriented-plugin.md +1343 -1343
  248. package/augment-extensions/domain-rules/wordpress-plugin/examples/rest-endpoint.md +734 -734
  249. package/augment-extensions/domain-rules/wordpress-plugin/examples/settings-page-plugin.md +1350 -1350
  250. package/augment-extensions/domain-rules/wordpress-plugin/examples/simple-procedural-plugin.md +503 -503
  251. package/augment-extensions/domain-rules/wordpress-plugin/examples/singleton-plugin.md +971 -971
  252. package/augment-extensions/domain-rules/wordpress-plugin/module.json +53 -53
  253. package/augment-extensions/domain-rules/wordpress-plugin/rules/activation-hooks.md +770 -770
  254. package/augment-extensions/domain-rules/wordpress-plugin/rules/admin-interface.md +874 -874
  255. package/augment-extensions/domain-rules/wordpress-plugin/rules/ajax-handlers.md +629 -629
  256. package/augment-extensions/domain-rules/wordpress-plugin/rules/asset-management.md +559 -559
  257. package/augment-extensions/domain-rules/wordpress-plugin/rules/context-providers.md +709 -709
  258. package/augment-extensions/domain-rules/wordpress-plugin/rules/cron-jobs.md +736 -736
  259. package/augment-extensions/domain-rules/wordpress-plugin/rules/database-management.md +1057 -1057
  260. package/augment-extensions/domain-rules/wordpress-plugin/rules/documentation-standards.md +463 -463
  261. package/augment-extensions/domain-rules/wordpress-plugin/rules/frontend-functionality.md +478 -478
  262. package/augment-extensions/domain-rules/wordpress-plugin/rules/gutenberg-blocks.md +818 -818
  263. package/augment-extensions/domain-rules/wordpress-plugin/rules/internationalization.md +416 -416
  264. package/augment-extensions/domain-rules/wordpress-plugin/rules/migration.md +667 -667
  265. package/augment-extensions/domain-rules/wordpress-plugin/rules/performance-optimization.md +878 -878
  266. package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-architecture.md +693 -693
  267. package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-structure.md +352 -352
  268. package/augment-extensions/domain-rules/wordpress-plugin/rules/rest-api.md +818 -818
  269. package/augment-extensions/domain-rules/wordpress-plugin/rules/scaffolding-workflow.md +624 -624
  270. package/augment-extensions/domain-rules/wordpress-plugin/rules/security-best-practices.md +866 -866
  271. package/augment-extensions/domain-rules/wordpress-plugin/rules/testing-patterns.md +1165 -1165
  272. package/augment-extensions/domain-rules/wordpress-plugin/rules/testing.md +414 -414
  273. package/augment-extensions/domain-rules/wordpress-plugin/rules/vscode-integration.md +751 -751
  274. package/augment-extensions/domain-rules/wordpress-plugin/rules/woocommerce-integration.md +949 -949
  275. package/augment-extensions/domain-rules/wordpress-plugin/rules/wordpress-org-submission.md +458 -458
  276. package/augment-extensions/examples/design-patterns/README.md +37 -37
  277. package/augment-extensions/examples/design-patterns/examples/behavioral-patterns.md +370 -370
  278. package/augment-extensions/examples/design-patterns/examples/creational-patterns.md +250 -250
  279. package/augment-extensions/examples/design-patterns/examples/structural-patterns.md +264 -264
  280. package/augment-extensions/examples/design-patterns/module.json +27 -27
  281. package/augment-extensions/examples/gutenberg-block-plugin/README.md +101 -101
  282. package/augment-extensions/examples/gutenberg-block-plugin/examples/testimonial-block.md +428 -428
  283. package/augment-extensions/examples/gutenberg-block-plugin/module.json +40 -40
  284. package/augment-extensions/examples/rest-api-plugin/README.md +98 -98
  285. package/augment-extensions/examples/rest-api-plugin/examples/task-manager-api.md +1299 -1299
  286. package/augment-extensions/examples/rest-api-plugin/module.json +40 -40
  287. package/augment-extensions/examples/woocommerce-extension/README.md +98 -98
  288. package/augment-extensions/examples/woocommerce-extension/examples/product-customizer.md +763 -763
  289. package/augment-extensions/examples/woocommerce-extension/module.json +40 -40
  290. package/augment-extensions/workflows/beads/README.md +135 -135
  291. package/augment-extensions/workflows/beads/examples/complete-workflow-example.md +278 -278
  292. package/augment-extensions/workflows/beads/module.json +55 -55
  293. package/augment-extensions/workflows/beads/rules/best-practices.md +398 -398
  294. package/augment-extensions/workflows/beads/rules/file-format.md +327 -327
  295. package/augment-extensions/workflows/beads/rules/manual-setup.md +315 -315
  296. package/augment-extensions/workflows/beads/rules/workflow.md +326 -326
  297. package/augment-extensions/workflows/beads-integration/IMPLEMENTATION-STATUS.md +145 -145
  298. package/augment-extensions/workflows/beads-integration/README.md +143 -143
  299. package/augment-extensions/workflows/beads-integration/config/defaults.json +32 -32
  300. package/augment-extensions/workflows/beads-integration/config/schema.json +140 -140
  301. package/augment-extensions/workflows/beads-integration/examples/basic-task-generation.md +293 -293
  302. package/augment-extensions/workflows/beads-integration/module.json +75 -75
  303. package/augment-extensions/workflows/beads-integration/rules/core-rules.md +219 -219
  304. package/augment-extensions/workflows/beads-integration/rules/effectiveness-standards.md +256 -256
  305. package/augment-extensions/workflows/beads-integration/rules/task-generation.md +607 -607
  306. package/augment-extensions/workflows/database/README.md +195 -195
  307. package/augment-extensions/workflows/database/ai-prompt-testing.md +295 -295
  308. package/augment-extensions/workflows/database/examples/migration-example.md +498 -498
  309. package/augment-extensions/workflows/database/examples/optimization-example.md +496 -496
  310. package/augment-extensions/workflows/database/examples/schema-design-example.md +444 -444
  311. package/augment-extensions/workflows/database/module.json +42 -42
  312. package/augment-extensions/workflows/database/rules/data-migration.md +249 -249
  313. package/augment-extensions/workflows/database/rules/documentation-standards.md +339 -339
  314. package/augment-extensions/workflows/database/rules/migration-workflow.md +352 -352
  315. package/augment-extensions/workflows/database/rules/optimization-workflow.md +435 -435
  316. package/augment-extensions/workflows/database/rules/schema-design-workflow.md +535 -535
  317. package/augment-extensions/workflows/database/rules/testing-patterns.md +305 -305
  318. package/augment-extensions/workflows/database/rules/workflow.md +458 -458
  319. package/augment-extensions/workflows/wordpress-plugin/README.md +232 -232
  320. package/augment-extensions/workflows/wordpress-plugin/ai-prompts.md +839 -839
  321. package/augment-extensions/workflows/wordpress-plugin/bead-decomposition-patterns.md +854 -854
  322. package/augment-extensions/workflows/wordpress-plugin/examples/complete-plugin-example.md +540 -540
  323. package/augment-extensions/workflows/wordpress-plugin/examples/custom-post-type-example.md +1083 -1083
  324. package/augment-extensions/workflows/wordpress-plugin/examples/feature-addition-workflow.md +669 -669
  325. package/augment-extensions/workflows/wordpress-plugin/examples/plugin-creation-workflow.md +597 -597
  326. package/augment-extensions/workflows/wordpress-plugin/examples/secure-form-handler-example.md +925 -925
  327. package/augment-extensions/workflows/wordpress-plugin/examples/security-audit-workflow.md +752 -752
  328. package/augment-extensions/workflows/wordpress-plugin/examples/wordpress-org-submission-workflow.md +773 -773
  329. package/augment-extensions/workflows/wordpress-plugin/module.json +49 -49
  330. package/augment-extensions/workflows/wordpress-plugin/rules/best-practices.md +942 -942
  331. package/augment-extensions/workflows/wordpress-plugin/rules/development-workflow.md +702 -702
  332. package/augment-extensions/workflows/wordpress-plugin/rules/submission-workflow.md +728 -728
  333. package/augment-extensions/workflows/wordpress-plugin/rules/testing-workflow.md +775 -775
  334. package/augment-extensions/writing-standards/screenplay/README.md +339 -300
  335. package/augment-extensions/writing-standards/screenplay/_templates/README.md +121 -121
  336. package/augment-extensions/writing-standards/screenplay/_templates/genre-template.md +153 -153
  337. package/augment-extensions/writing-standards/screenplay/_templates/style-template.md +243 -243
  338. package/augment-extensions/writing-standards/screenplay/_templates/theme-template.md +213 -213
  339. package/augment-extensions/writing-standards/screenplay/examples/aaa-hollywood-scene.fountain +164 -164
  340. package/augment-extensions/writing-standards/screenplay/examples/beat-sheet-example.yaml +95 -95
  341. package/augment-extensions/writing-standards/screenplay/examples/character-profile-example.yaml +116 -116
  342. package/augment-extensions/writing-standards/screenplay/examples/commercial-30sec.fountain +151 -151
  343. package/augment-extensions/writing-standards/screenplay/examples/independent-monologue.fountain +67 -67
  344. package/augment-extensions/writing-standards/screenplay/examples/news-segment.fountain +142 -142
  345. package/augment-extensions/writing-standards/screenplay/examples/plot-outline-example.yaml +184 -184
  346. package/augment-extensions/writing-standards/screenplay/examples/tv-episode-teaser.fountain +204 -204
  347. package/augment-extensions/writing-standards/screenplay/genres/README.md +181 -181
  348. package/augment-extensions/writing-standards/screenplay/genres/examples/.gitkeep +2 -2
  349. package/augment-extensions/writing-standards/screenplay/genres/module.json +70 -70
  350. package/augment-extensions/writing-standards/screenplay/genres/rules/.gitkeep +2 -2
  351. package/augment-extensions/writing-standards/screenplay/genres/rules/action.md +399 -399
  352. package/augment-extensions/writing-standards/screenplay/genres/rules/adventure.md +407 -407
  353. package/augment-extensions/writing-standards/screenplay/genres/rules/animation.md +293 -293
  354. package/augment-extensions/writing-standards/screenplay/genres/rules/biographical.md +293 -293
  355. package/augment-extensions/writing-standards/screenplay/genres/rules/comedy.md +401 -401
  356. package/augment-extensions/writing-standards/screenplay/genres/rules/documentary.md +293 -293
  357. package/augment-extensions/writing-standards/screenplay/genres/rules/drama.md +409 -409
  358. package/augment-extensions/writing-standards/screenplay/genres/rules/fantasy.md +293 -293
  359. package/augment-extensions/writing-standards/screenplay/genres/rules/historical.md +293 -293
  360. package/augment-extensions/writing-standards/screenplay/genres/rules/horror.md +268 -268
  361. package/augment-extensions/writing-standards/screenplay/genres/rules/musical.md +294 -294
  362. package/augment-extensions/writing-standards/screenplay/genres/rules/mystery.md +293 -293
  363. package/augment-extensions/writing-standards/screenplay/genres/rules/noir.md +294 -294
  364. package/augment-extensions/writing-standards/screenplay/genres/rules/romance.md +293 -293
  365. package/augment-extensions/writing-standards/screenplay/genres/rules/sci-fi.md +289 -289
  366. package/augment-extensions/writing-standards/screenplay/genres/rules/superhero.md +293 -293
  367. package/augment-extensions/writing-standards/screenplay/genres/rules/thriller.md +294 -294
  368. package/augment-extensions/writing-standards/screenplay/genres/rules/western.md +293 -293
  369. package/augment-extensions/writing-standards/screenplay/module.json +124 -124
  370. package/augment-extensions/writing-standards/screenplay/rules/aaa-hollywood-films.md +339 -339
  371. package/augment-extensions/writing-standards/screenplay/rules/ai-integration-testing.md +329 -329
  372. package/augment-extensions/writing-standards/screenplay/rules/character-development.md +169 -169
  373. package/augment-extensions/writing-standards/screenplay/rules/commercials.md +437 -437
  374. package/augment-extensions/writing-standards/screenplay/rules/dialogue-writing.md +263 -263
  375. package/augment-extensions/writing-standards/screenplay/rules/diversity-inclusion.md +261 -261
  376. package/augment-extensions/writing-standards/screenplay/rules/examples-guide.md +315 -315
  377. package/augment-extensions/writing-standards/screenplay/rules/file-organization.md +213 -0
  378. package/augment-extensions/writing-standards/screenplay/rules/formatting-validation.md +413 -413
  379. package/augment-extensions/writing-standards/screenplay/rules/fountain-format.md +372 -372
  380. package/augment-extensions/writing-standards/screenplay/rules/independent-films.md +374 -374
  381. package/augment-extensions/writing-standards/screenplay/rules/live-tv-productions.md +443 -443
  382. package/augment-extensions/writing-standards/screenplay/rules/narrative-structures.md +207 -207
  383. package/augment-extensions/writing-standards/screenplay/rules/news-broadcasts.md +444 -444
  384. package/augment-extensions/writing-standards/screenplay/rules/pacing-timing.md +331 -331
  385. package/augment-extensions/writing-standards/screenplay/rules/quality-review-checklist.md +334 -334
  386. package/augment-extensions/writing-standards/screenplay/rules/quick-reference.md +299 -299
  387. package/augment-extensions/writing-standards/screenplay/rules/screen-continuity.md +263 -263
  388. package/augment-extensions/writing-standards/screenplay/rules/streaming-content.md +412 -412
  389. package/augment-extensions/writing-standards/screenplay/rules/trope-management.md +370 -370
  390. package/augment-extensions/writing-standards/screenplay/rules/tv-series.md +374 -374
  391. package/augment-extensions/writing-standards/screenplay/rules/universal-formatting.md +339 -339
  392. package/augment-extensions/writing-standards/screenplay/rules/vscode-integration.md +277 -277
  393. package/augment-extensions/writing-standards/screenplay/rules/web-content.md +393 -393
  394. package/augment-extensions/writing-standards/screenplay/schemas/beat-sheet.json +332 -332
  395. package/augment-extensions/writing-standards/screenplay/schemas/character-profile.json +247 -247
  396. package/augment-extensions/writing-standards/screenplay/schemas/feature-selection.json +200 -200
  397. package/augment-extensions/writing-standards/screenplay/schemas/plot-outline.json +233 -233
  398. package/augment-extensions/writing-standards/screenplay/schemas/screenplay-config.json +245 -245
  399. package/augment-extensions/writing-standards/screenplay/schemas/trope-inventory.json +221 -221
  400. package/augment-extensions/writing-standards/screenplay/styles/README.md +159 -159
  401. package/augment-extensions/writing-standards/screenplay/styles/examples/.gitkeep +2 -2
  402. package/augment-extensions/writing-standards/screenplay/styles/examples/style-applications.md +1449 -1449
  403. package/augment-extensions/writing-standards/screenplay/styles/module.json +64 -64
  404. package/augment-extensions/writing-standards/screenplay/styles/rules/.gitkeep +2 -2
  405. package/augment-extensions/writing-standards/screenplay/styles/rules/dialogue-centric.md +520 -520
  406. package/augment-extensions/writing-standards/screenplay/styles/rules/ensemble.md +499 -499
  407. package/augment-extensions/writing-standards/screenplay/styles/rules/epic.md +497 -497
  408. package/augment-extensions/writing-standards/screenplay/styles/rules/experimental.md +492 -492
  409. package/augment-extensions/writing-standards/screenplay/styles/rules/flashback.md +509 -509
  410. package/augment-extensions/writing-standards/screenplay/styles/rules/linear.md +490 -490
  411. package/augment-extensions/writing-standards/screenplay/styles/rules/minimalist.md +499 -499
  412. package/augment-extensions/writing-standards/screenplay/styles/rules/non-linear.md +501 -501
  413. package/augment-extensions/writing-standards/screenplay/styles/rules/poetic.md +499 -499
  414. package/augment-extensions/writing-standards/screenplay/styles/rules/realistic.md +498 -498
  415. package/augment-extensions/writing-standards/screenplay/styles/rules/satirical.md +499 -499
  416. package/augment-extensions/writing-standards/screenplay/styles/rules/surreal.md +508 -508
  417. package/augment-extensions/writing-standards/screenplay/styles/rules/voice-over.md +500 -500
  418. package/augment-extensions/writing-standards/screenplay/themes/README.md +158 -158
  419. package/augment-extensions/writing-standards/screenplay/themes/examples/.gitkeep +2 -2
  420. package/augment-extensions/writing-standards/screenplay/themes/examples/common-mistakes-and-fixes.md +643 -643
  421. package/augment-extensions/writing-standards/screenplay/themes/examples/complete-scene-example.md +311 -311
  422. package/augment-extensions/writing-standards/screenplay/themes/examples/individual-theme-examples.md +562 -562
  423. package/augment-extensions/writing-standards/screenplay/themes/examples/multi-theme-weaving.md +538 -538
  424. package/augment-extensions/writing-standards/screenplay/themes/examples/theme-application-guide.md +432 -432
  425. package/augment-extensions/writing-standards/screenplay/themes/examples/theme-integration-across-acts.md +637 -637
  426. package/augment-extensions/writing-standards/screenplay/themes/module.json +66 -66
  427. package/augment-extensions/writing-standards/screenplay/themes/rules/.gitkeep +2 -2
  428. package/augment-extensions/writing-standards/screenplay/themes/rules/ambition.md +458 -458
  429. package/augment-extensions/writing-standards/screenplay/themes/rules/betrayal.md +490 -490
  430. package/augment-extensions/writing-standards/screenplay/themes/rules/environment.md +458 -458
  431. package/augment-extensions/writing-standards/screenplay/themes/rules/fate.md +459 -459
  432. package/augment-extensions/writing-standards/screenplay/themes/rules/friendship.md +491 -491
  433. package/augment-extensions/writing-standards/screenplay/themes/rules/growth.md +491 -491
  434. package/augment-extensions/writing-standards/screenplay/themes/rules/identity.md +490 -490
  435. package/augment-extensions/writing-standards/screenplay/themes/rules/isolation.md +464 -464
  436. package/augment-extensions/writing-standards/screenplay/themes/rules/justice.md +461 -461
  437. package/augment-extensions/writing-standards/screenplay/themes/rules/love.md +489 -489
  438. package/augment-extensions/writing-standards/screenplay/themes/rules/power.md +494 -494
  439. package/augment-extensions/writing-standards/screenplay/themes/rules/redemption.md +483 -483
  440. package/augment-extensions/writing-standards/screenplay/themes/rules/revenge.md +489 -489
  441. package/augment-extensions/writing-standards/screenplay/themes/rules/survival.md +496 -496
  442. package/augment-extensions/writing-standards/screenplay/themes/rules/technology.md +463 -463
  443. package/augment-extensions/writing-standards/screenplay/utils/__tests__/file-organization.test.ts +169 -0
  444. package/augment-extensions/writing-standards/screenplay/utils/file-organization.ts +165 -0
  445. package/cli/MODULES.md +302 -302
  446. package/cli/dist/cli.js +109 -22
  447. package/cli/dist/cli.js.map +1 -1
  448. package/cli/dist/commands/gui.d.ts.map +1 -1
  449. package/cli/dist/commands/gui.js +54 -6
  450. package/cli/dist/commands/gui.js.map +1 -1
  451. package/cli/dist/commands/init.d.ts.map +1 -1
  452. package/cli/dist/commands/init.js +76 -23
  453. package/cli/dist/commands/init.js.map +1 -1
  454. package/cli/dist/commands/self-remove.d.ts.map +1 -1
  455. package/cli/dist/commands/self-remove.js +48 -74
  456. package/cli/dist/commands/self-remove.js.map +1 -1
  457. package/cli/dist/commands/show.d.ts +11 -0
  458. package/cli/dist/commands/show.d.ts.map +1 -1
  459. package/cli/dist/commands/show.js +120 -0
  460. package/cli/dist/commands/show.js.map +1 -1
  461. package/cli/dist/commands/showCompleted.d.ts +21 -0
  462. package/cli/dist/commands/showCompleted.d.ts.map +1 -0
  463. package/cli/dist/commands/showCompleted.js +225 -0
  464. package/cli/dist/commands/showCompleted.js.map +1 -0
  465. package/cli/dist/commands/skill.js +88 -88
  466. package/cli/dist/commands/update.d.ts +2 -0
  467. package/cli/dist/commands/update.d.ts.map +1 -1
  468. package/cli/dist/commands/update.js +67 -1
  469. package/cli/dist/commands/update.js.map +1 -1
  470. package/cli/dist/utils/beadsCompletedChecker.d.ts +72 -0
  471. package/cli/dist/utils/beadsCompletedChecker.d.ts.map +1 -0
  472. package/cli/dist/utils/beadsCompletedChecker.js +198 -0
  473. package/cli/dist/utils/beadsCompletedChecker.js.map +1 -0
  474. package/cli/dist/utils/catalog-sync.js +13 -13
  475. package/cli/dist/utils/extractCommandHelp.d.ts +51 -0
  476. package/cli/dist/utils/extractCommandHelp.d.ts.map +1 -0
  477. package/cli/dist/utils/extractCommandHelp.js +250 -0
  478. package/cli/dist/utils/extractCommandHelp.js.map +1 -0
  479. package/cli/dist/utils/install-rules.js +55 -55
  480. package/cli/dist/utils/mcp-integration.js +44 -44
  481. package/cli/dist/utils/rule-install-hooks.js +8 -8
  482. package/modules.md +667 -630
  483. package/package.json +85 -85
@@ -1,856 +1,856 @@
1
- # NoSQL Document Stores
2
-
3
- ## Overview
4
-
5
- This document covers document store databases (MongoDB, CouchDB, Couchbase), including schema design patterns (embedding vs referencing), denormalization strategies, indexing, aggregation pipelines, transactions, sharding, replication, and query optimization.
6
-
7
- ---
8
-
9
- ## Document Store Fundamentals
10
-
11
- ### What is a Document Store?
12
-
13
- **Definition**: Database that stores data as documents (typically JSON/BSON)
14
-
15
- **Characteristics:**
16
- - Documents are self-contained units of data
17
- - Flexible schema (each document can have different fields)
18
- - Nested data structures (arrays, objects)
19
- - Rich query capabilities
20
- - Horizontal scalability
21
-
22
- **Document Example:**
23
- ```json
24
- {
25
- "_id": "507f1f77bcf86cd799439011",
26
- "name": "John Doe",
27
- "email": "john@example.com",
28
- "age": 30,
29
- "addresses": [
30
- {
31
- "type": "home",
32
- "street": "123 Main St",
33
- "city": "Boston",
34
- "state": "MA",
35
- "zip": "02101"
36
- }
37
- ],
38
- "preferences": {
39
- "newsletter": true,
40
- "notifications": {
41
- "email": true,
42
- "sms": false
43
- }
44
- },
45
- "created_at": "2024-01-15T10:00:00Z",
46
- "updated_at": "2024-01-15T10:00:00Z"
47
- }
48
- ```
49
-
50
- ### Popular Document Databases
51
-
52
- **MongoDB:**
53
- - Most popular document database
54
- - BSON (Binary JSON) format
55
- - Rich query language
56
- - Aggregation framework
57
- - Sharding and replication
58
- - ACID transactions (4.0+)
59
-
60
- **CouchDB:**
61
- - HTTP/REST API
62
- - Multi-version concurrency control (MVCC)
63
- - Eventual consistency
64
- - Master-master replication
65
- - MapReduce views
66
-
67
- **Couchbase:**
68
- - Combines document store with key-value store
69
- - N1QL query language (SQL-like)
70
- - Built-in caching
71
- - High performance
72
- - Mobile sync (Couchbase Lite)
73
-
74
- ---
75
-
76
- ## Schema Design Patterns
77
-
78
- ### Embedding vs Referencing
79
-
80
- **Key Decision**: Should related data be embedded or referenced?
81
-
82
- #### Embedding (Denormalization)
83
-
84
- **Store related data within the same document:**
85
-
86
- ```javascript
87
- // User with embedded addresses
88
- {
89
- "_id": "user123",
90
- "name": "John Doe",
91
- "email": "john@example.com",
92
- "addresses": [
93
- { "type": "home", "street": "123 Main St", "city": "Boston" },
94
- { "type": "work", "street": "456 Office Blvd", "city": "Cambridge" }
95
- ],
96
- "payment_methods": [
97
- { "type": "credit_card", "last4": "1234", "brand": "Visa" },
98
- { "type": "paypal", "email": "john@paypal.com" }
99
- ]
100
- }
101
- ```
102
-
103
- **Advantages:**
104
- - ✅ Single query to retrieve all data
105
- - ✅ Better read performance
106
- - ✅ Atomic updates (single document)
107
- - ✅ Data locality (related data stored together)
108
-
109
- **Disadvantages:**
110
- - ❌ Data duplication
111
- - ❌ Document size limits (16MB in MongoDB)
112
- - ❌ Difficult to query embedded data across documents
113
- - ❌ Update complexity if data is duplicated
114
-
115
- **When to embed:**
116
- - ✅ One-to-few relationships (< 100 items)
117
- - ✅ Data is always accessed together
118
- - ✅ Data doesn't change frequently
119
- - ✅ Embedded data is specific to parent document
120
-
121
- #### Referencing (Normalization)
122
-
123
- **Store references (IDs) to related data:**
124
-
125
- ```javascript
126
- // User document
127
- {
128
- "_id": "user123",
129
- "name": "John Doe",
130
- "email": "john@example.com"
131
- }
132
-
133
- // Address documents (separate collection)
134
- {
135
- "_id": "addr456",
136
- "user_id": "user123",
137
- "type": "home",
138
- "street": "123 Main St",
139
- "city": "Boston"
140
- }
141
-
142
- {
143
- "_id": "addr789",
144
- "user_id": "user123",
145
- "type": "work",
146
- "street": "456 Office Blvd",
147
- "city": "Cambridge"
148
- }
149
- ```
150
-
151
- **Advantages:**
152
- - ✅ No data duplication
153
- - ✅ Smaller document size
154
- - ✅ Easier to query related data independently
155
- - ✅ Easier to update (single location)
156
-
157
- **Disadvantages:**
158
- - ❌ Multiple queries required (application-level joins)
159
- - ❌ Slower read performance
160
- - ❌ No atomic updates across documents (without transactions)
161
-
162
- **When to reference:**
163
- - ✅ One-to-many or many-to-many relationships
164
- - ✅ Data is accessed independently
165
- - ✅ Data changes frequently
166
- - ✅ Embedded data would exceed document size limits
167
- - ✅ Data is shared across multiple documents
168
-
169
- ### Hybrid Approach
170
-
171
- **Combine embedding and referencing:**
172
-
173
- ```javascript
174
- // Blog post with embedded author summary + reference
175
- {
176
- "_id": "post123",
177
- "title": "Introduction to NoSQL",
178
- "content": "...",
179
- "author": {
180
- "id": "user456", // Reference to full user document
181
- "name": "John Doe", // Embedded for display
182
- "avatar_url": "..." // Embedded for display
183
- },
184
- "comments": [
185
- {
186
- "id": "comment789",
187
- "author": {
188
- "id": "user789",
189
- "name": "Jane Smith"
190
- },
191
- "text": "Great article!",
192
- "created_at": "2024-01-15T11:00:00Z"
193
- }
194
- ],
195
- "tags": ["nosql", "mongodb", "databases"], // Embedded (small, static)
196
- "category_id": "cat123", // Reference (shared across posts)
197
- "created_at": "2024-01-15T10:00:00Z"
198
- }
199
- ```
200
-
201
- **Benefits:**
202
- - ✅ Fast reads (embedded display data)
203
- - ✅ Consistent updates (reference to source of truth)
204
- - ✅ Flexible querying
205
-
206
- ### One-to-Many Relationships
207
-
208
- **Pattern 1: Embed child in parent (one-to-few)**
209
- ```javascript
210
- // Order with embedded line items
211
- {
212
- "_id": "order123",
213
- "customer_id": "user456",
214
- "items": [
215
- { "product_id": "prod789", "name": "Widget", "quantity": 2, "price": 10.00 },
216
- { "product_id": "prod012", "name": "Gadget", "quantity": 1, "price": 25.00 }
217
- ],
218
- "total": 45.00,
219
- "status": "shipped"
220
- }
221
- ```
222
-
223
- **Pattern 2: Reference parent in child (one-to-many)**
224
- ```javascript
225
- // User document
226
- { "_id": "user456", "name": "John Doe" }
227
-
228
- // Order documents (many)
229
- { "_id": "order123", "user_id": "user456", "total": 45.00 }
230
- { "_id": "order124", "user_id": "user456", "total": 99.99 }
231
- ```
232
-
233
- **Pattern 3: Reference children in parent (one-to-many)**
234
- ```javascript
235
- // User with order references
236
- {
237
- "_id": "user456",
238
- "name": "John Doe",
239
- "order_ids": ["order123", "order124", "order125"]
240
- }
241
-
242
- // Order documents
243
- { "_id": "order123", "total": 45.00 }
244
- { "_id": "order124", "total": 99.99 }
245
- ```
246
-
247
- ### Many-to-Many Relationships
248
-
249
- **Pattern 1: Embed array of references**
250
- ```javascript
251
- // Product with category references
252
- {
253
- "_id": "prod123",
254
- "name": "Laptop",
255
- "category_ids": ["cat_electronics", "cat_computers", "cat_office"]
256
- }
257
-
258
- // Category with product references
259
- {
260
- "_id": "cat_electronics",
261
- "name": "Electronics",
262
- "product_ids": ["prod123", "prod456", "prod789"]
263
- }
264
- ```
265
-
266
- **Pattern 2: Junction collection**
267
- ```javascript
268
- // Product document
269
- { "_id": "prod123", "name": "Laptop" }
270
-
271
- // Category document
272
- { "_id": "cat_electronics", "name": "Electronics" }
273
-
274
- // ProductCategory junction
275
- {
276
- "_id": "pc123",
277
- "product_id": "prod123",
278
- "category_id": "cat_electronics",
279
- "featured": true,
280
- "sort_order": 1
281
- }
282
- ```
283
-
284
- ---
285
-
286
- ## Indexing
287
-
288
- ### Index Types
289
-
290
- **Single Field Index:**
291
- ```javascript
292
- // Create index on email field
293
- db.users.createIndex({ email: 1 }); // 1 = ascending, -1 = descending
294
-
295
- // Query uses index
296
- db.users.find({ email: "john@example.com" });
297
- ```
298
-
299
- **Compound Index:**
300
- ```javascript
301
- // Create compound index
302
- db.orders.createIndex({ user_id: 1, created_at: -1 });
303
-
304
- // Queries that use this index
305
- db.orders.find({ user_id: "user123" }).sort({ created_at: -1 });
306
- db.orders.find({ user_id: "user123", created_at: { $gte: new Date("2024-01-01") } });
307
- ```
308
-
309
- **Multikey Index (Arrays):**
310
- ```javascript
311
- // Create index on array field
312
- db.products.createIndex({ tags: 1 });
313
-
314
- // Query uses index
315
- db.products.find({ tags: "electronics" });
316
- ```
317
-
318
- **Text Index (Full-Text Search):**
319
- ```javascript
320
- // Create text index
321
- db.articles.createIndex({ title: "text", content: "text" });
322
-
323
- // Full-text search
324
- db.articles.find({ $text: { $search: "mongodb tutorial" } });
325
- ```
326
-
327
- **Geospatial Index:**
328
- ```javascript
329
- // Create 2dsphere index for location data
330
- db.places.createIndex({ location: "2dsphere" });
331
-
332
- // Find places near coordinates
333
- db.places.find({
334
- location: {
335
- $near: {
336
- $geometry: { type: "Point", coordinates: [-73.97, 40.77] },
337
- $maxDistance: 5000 // meters
338
- }
339
- }
340
- });
341
- ```
342
-
343
- **Unique Index:**
344
- ```javascript
345
- // Create unique index
346
- db.users.createIndex({ email: 1 }, { unique: true });
347
-
348
- // Duplicate emails will be rejected
349
- ```
350
-
351
- **Partial Index:**
352
- ```javascript
353
- // Index only documents matching filter
354
- db.orders.createIndex(
355
- { user_id: 1, created_at: -1 },
356
- { partialFilterExpression: { status: "active" } }
357
- );
358
-
359
- // Only indexes active orders
360
- ```
361
-
362
- **TTL Index (Time-To-Live):**
363
- ```javascript
364
- // Auto-delete documents after expiration
365
- db.sessions.createIndex(
366
- { created_at: 1 },
367
- { expireAfterSeconds: 3600 } // Delete after 1 hour
368
- );
369
- ```
370
-
371
- ### Index Best Practices
372
-
373
- **DO:**
374
- - ✅ Create indexes for frequently queried fields
375
- - ✅ Use compound indexes for multi-field queries
376
- - ✅ Create indexes before querying large collections
377
- - ✅ Use covered queries (query only indexed fields)
378
- - ✅ Monitor index usage with explain()
379
- - ✅ Remove unused indexes
380
-
381
- **DON'T:**
382
- - ❌ Create too many indexes (slows writes)
383
- - ❌ Index low-cardinality fields (few unique values)
384
- - ❌ Forget to index foreign keys
385
- - ❌ Create redundant indexes
386
-
387
- ---
388
-
389
- ## Aggregation Pipelines
390
-
391
- ### What is Aggregation?
392
-
393
- **Definition**: Process documents through a pipeline of stages to compute results
394
-
395
- **Common stages:**
396
- - `$match`: Filter documents
397
- - `$group`: Group by field and compute aggregates
398
- - `$project`: Select/transform fields
399
- - `$sort`: Sort documents
400
- - `$limit`: Limit number of documents
401
- - `$skip`: Skip documents
402
- - `$lookup`: Join with another collection
403
- - `$unwind`: Deconstruct array field
404
-
405
- ### Aggregation Examples
406
-
407
- **Example 1: Group and count**
408
- ```javascript
409
- // Count orders by status
410
- db.orders.aggregate([
411
- { $group: { _id: "$status", count: { $sum: 1 } } },
412
- { $sort: { count: -1 } }
413
- ]);
414
-
415
- // Result:
416
- // [
417
- // { "_id": "shipped", "count": 150 },
418
- // { "_id": "pending", "count": 45 },
419
- // { "_id": "cancelled", "count": 5 }
420
- // ]
421
- ```
422
-
423
- **Example 2: Filter, group, and calculate**
424
- ```javascript
425
- // Total revenue by user for orders in 2024
426
- db.orders.aggregate([
427
- { $match: { created_at: { $gte: new Date("2024-01-01") } } },
428
- { $group: {
429
- _id: "$user_id",
430
- total_revenue: { $sum: "$total" },
431
- order_count: { $sum: 1 },
432
- avg_order: { $avg: "$total" }
433
- }
434
- },
435
- { $sort: { total_revenue: -1 } },
436
- { $limit: 10 }
437
- ]);
438
- ```
439
-
440
- **Example 3: Unwind array and group**
441
- ```javascript
442
- // Count products by tag
443
- db.products.aggregate([
444
- { $unwind: "$tags" },
445
- { $group: { _id: "$tags", count: { $sum: 1 } } },
446
- { $sort: { count: -1 } }
447
- ]);
448
- ```
449
-
450
- **Example 4: Lookup (join)**
451
- ```javascript
452
- // Join orders with user data
453
- db.orders.aggregate([
454
- { $lookup: {
455
- from: "users",
456
- localField: "user_id",
457
- foreignField: "_id",
458
- as: "user"
459
- }
460
- },
461
- { $unwind: "$user" },
462
- { $project: {
463
- order_id: "$_id",
464
- total: 1,
465
- user_name: "$user.name",
466
- user_email: "$user.email"
467
- }
468
- }
469
- ]);
470
- ```
471
-
472
- **Example 5: Complex aggregation with multiple stages**
473
- ```javascript
474
- // Top 5 customers by revenue with order details
475
- db.orders.aggregate([
476
- { $match: { status: "completed" } },
477
- { $group: {
478
- _id: "$user_id",
479
- total_spent: { $sum: "$total" },
480
- order_count: { $sum: 1 },
481
- orders: { $push: { order_id: "$_id", total: "$total", date: "$created_at" } }
482
- }
483
- },
484
- { $lookup: {
485
- from: "users",
486
- localField: "_id",
487
- foreignField: "_id",
488
- as: "user"
489
- }
490
- },
491
- { $unwind: "$user" },
492
- { $project: {
493
- user_name: "$user.name",
494
- user_email: "$user.email",
495
- total_spent: 1,
496
- order_count: 1,
497
- avg_order: { $divide: ["$total_spent", "$order_count"] },
498
- orders: 1
499
- }
500
- },
501
- { $sort: { total_spent: -1 } },
502
- { $limit: 5 }
503
- ]);
504
- ```
505
-
506
- ---
507
-
508
- ## Transactions
509
-
510
- ### Multi-Document Transactions (MongoDB 4.0+)
511
-
512
- **ACID transactions across multiple documents:**
513
-
514
- ```javascript
515
- const session = client.startSession();
516
-
517
- try {
518
- await session.withTransaction(async () => {
519
- // Deduct from sender
520
- await db.accounts.updateOne(
521
- { _id: senderId },
522
- { $inc: { balance: -amount } },
523
- { session }
524
- );
525
-
526
- // Add to receiver
527
- await db.accounts.updateOne(
528
- { _id: receiverId },
529
- { $inc: { balance: amount } },
530
- { session }
531
- );
532
-
533
- // Log transaction
534
- await db.transactions.insertOne({
535
- from: senderId,
536
- to: receiverId,
537
- amount: amount,
538
- timestamp: new Date()
539
- }, { session });
540
- });
541
-
542
- console.log("Transaction committed");
543
- } catch (error) {
544
- console.log("Transaction aborted:", error);
545
- } finally {
546
- await session.endSession();
547
- }
548
- ```
549
-
550
- ### Single-Document Atomicity
551
-
552
- **All updates to a single document are atomic:**
553
-
554
- ```javascript
555
- // Atomic update - all fields updated together
556
- db.orders.updateOne(
557
- { _id: orderId },
558
- {
559
- $set: { status: "shipped", shipped_at: new Date() },
560
- $inc: { version: 1 },
561
- $push: { status_history: { status: "shipped", timestamp: new Date() } }
562
- }
563
- );
564
- ```
565
-
566
- ### Optimistic Concurrency Control
567
-
568
- **Use version field to prevent conflicts:**
569
-
570
- ```javascript
571
- // Read document with version
572
- const product = await db.products.findOne({ _id: productId });
573
- const currentVersion = product.version;
574
-
575
- // Update with version check
576
- const result = await db.products.updateOne(
577
- { _id: productId, version: currentVersion },
578
- {
579
- $set: { stock: product.stock - quantity },
580
- $inc: { version: 1 }
581
- }
582
- );
583
-
584
- if (result.modifiedCount === 0) {
585
- throw new Error("Concurrent modification detected - retry");
586
- }
587
- ```
588
-
589
- ---
590
-
591
- ## Sharding
592
-
593
- ### What is Sharding?
594
-
595
- **Definition**: Horizontal partitioning of data across multiple servers
596
-
597
- **Benefits:**
598
- - ✅ Horizontal scalability
599
- - ✅ Distribute load across servers
600
- - ✅ Store more data than single server can handle
601
-
602
- **Shard Key**: Field used to partition data
603
-
604
- ### Choosing a Shard Key
605
-
606
- **Good shard keys:**
607
- - ✅ High cardinality (many unique values)
608
- - ✅ Even distribution of data
609
- - ✅ Supports common query patterns
610
- - ✅ Rarely updated
611
-
612
- **Bad shard keys:**
613
- - ❌ Low cardinality (few unique values)
614
- - ❌ Monotonically increasing (e.g., auto-increment ID, timestamp)
615
- - ❌ Frequently updated
616
-
617
- **Example: Shard by user_id**
618
- ```javascript
619
- // Enable sharding on database
620
- sh.enableSharding("myapp");
621
-
622
- // Shard collection by user_id
623
- sh.shardCollection("myapp.orders", { user_id: 1 });
624
-
625
- // Queries with user_id are routed to specific shard
626
- db.orders.find({ user_id: "user123" }); // Targeted query
627
-
628
- // Queries without user_id scan all shards
629
- db.orders.find({ status: "pending" }); // Scatter-gather query
630
- ```
631
-
632
- **Example: Compound shard key**
633
- ```javascript
634
- // Shard by user_id and created_at
635
- sh.shardCollection("myapp.events", { user_id: 1, created_at: 1 });
636
-
637
- // Better distribution for time-series data
638
- ```
639
-
640
- ---
641
-
642
- ## Replication
643
-
644
- ### What is Replication?
645
-
646
- **Definition**: Maintain multiple copies of data across servers
647
-
648
- **Benefits:**
649
- - ✅ High availability (failover)
650
- - ✅ Data redundancy
651
- - ✅ Read scalability (read from replicas)
652
- - ✅ Disaster recovery
653
-
654
- ### MongoDB Replica Set
655
-
656
- **Architecture:**
657
- - **Primary**: Accepts writes
658
- - **Secondary**: Replicates from primary
659
- - **Arbiter**: Participates in elections (no data)
660
-
661
- **Example: Configure replica set**
662
- ```javascript
663
- // Initialize replica set
664
- rs.initiate({
665
- _id: "myReplicaSet",
666
- members: [
667
- { _id: 0, host: "mongo1:27017" },
668
- { _id: 1, host: "mongo2:27017" },
669
- { _id: 2, host: "mongo3:27017" }
670
- ]
671
- });
672
-
673
- // Check status
674
- rs.status();
675
- ```
676
-
677
- **Read Preferences:**
678
- ```javascript
679
- // Read from primary (default)
680
- db.users.find().readPref("primary");
681
-
682
- // Read from secondary (eventual consistency)
683
- db.users.find().readPref("secondary");
684
-
685
- // Read from primary preferred
686
- db.users.find().readPref("primaryPreferred");
687
-
688
- // Read from nearest (lowest latency)
689
- db.users.find().readPref("nearest");
690
- ```
691
-
692
- **Write Concerns:**
693
- ```javascript
694
- // Wait for write to be acknowledged by majority
695
- db.orders.insertOne(
696
- { user_id: "user123", total: 99.99 },
697
- { writeConcern: { w: "majority", wtimeout: 5000 } }
698
- );
699
-
700
- // Write to primary only (faster, less durable)
701
- db.logs.insertOne(
702
- { message: "User logged in" },
703
- { writeConcern: { w: 1 } }
704
- );
705
- ```
706
-
707
- ---
708
-
709
- ## Query Optimization
710
-
711
- ### Use Indexes
712
-
713
- **Always create indexes for queried fields:**
714
-
715
- ```javascript
716
- // Create index
717
- db.users.createIndex({ email: 1 });
718
-
719
- // Query uses index
720
- db.users.find({ email: "john@example.com" });
721
- ```
722
-
723
- ### Analyze Query Performance
724
-
725
- **Use explain() to analyze queries:**
726
-
727
- ```javascript
728
- // Explain query execution
729
- db.users.find({ email: "john@example.com" }).explain("executionStats");
730
-
731
- // Look for:
732
- // - "IXSCAN" (index scan) vs "COLLSCAN" (collection scan)
733
- // - executionTimeMillis
734
- // - totalDocsExamined vs nReturned
735
- ```
736
-
737
- ### Covered Queries
738
-
739
- **Query only indexed fields (no document fetch):**
740
-
741
- ```javascript
742
- // Create index
743
- db.users.createIndex({ email: 1, name: 1 });
744
-
745
- // Covered query (only returns indexed fields)
746
- db.users.find(
747
- { email: "john@example.com" },
748
- { _id: 0, email: 1, name: 1 }
749
- );
750
- ```
751
-
752
- ### Limit Results
753
-
754
- **Always limit results when possible:**
755
-
756
- ```javascript
757
- // Limit to 10 results
758
- db.users.find({ status: "active" }).limit(10);
759
-
760
- // Pagination
761
- db.users.find({ status: "active" }).skip(20).limit(10);
762
- ```
763
-
764
- ### Project Only Needed Fields
765
-
766
- **Don't fetch unnecessary fields:**
767
-
768
- ```javascript
769
- // ❌ BAD: Fetch entire document
770
- db.users.find({ status: "active" });
771
-
772
- // ✅ GOOD: Fetch only needed fields
773
- db.users.find(
774
- { status: "active" },
775
- { name: 1, email: 1, _id: 0 }
776
- );
777
- ```
778
-
779
- ### Avoid Large Documents
780
-
781
- **Keep documents under 16MB (MongoDB limit):**
782
-
783
- ```javascript
784
- // ❌ BAD: Unbounded array growth
785
- {
786
- "_id": "user123",
787
- "events": [/* thousands of events */]
788
- }
789
-
790
- // ✅ GOOD: Reference separate collection
791
- {
792
- "_id": "user123",
793
- "name": "John Doe"
794
- }
795
-
796
- // Events in separate collection
797
- {
798
- "_id": "event456",
799
- "user_id": "user123",
800
- "type": "login",
801
- "timestamp": "2024-01-15T10:00:00Z"
802
- }
803
- ```
804
-
805
- ---
806
-
807
- ## Best Practices
808
-
809
- ### DO
810
-
811
- ✅ **Design schema for your queries** (query-driven design)
812
- ✅ **Use embedding for one-to-few relationships**
813
- ✅ **Use referencing for one-to-many relationships**
814
- ✅ **Create indexes for frequently queried fields**
815
- ✅ **Use aggregation pipelines for complex queries**
816
- ✅ **Implement schema validation** (MongoDB schema validation)
817
- ✅ **Use transactions when needed** (MongoDB 4.0+)
818
- ✅ **Monitor query performance** with explain()
819
- ✅ **Shard for horizontal scalability**
820
- ✅ **Replicate for high availability**
821
-
822
- ### DON'T
823
-
824
- ❌ **Don't over-normalize** - embrace denormalization
825
- ❌ **Don't create unbounded arrays** - use separate collections
826
- ❌ **Don't skip indexing** - queries will be slow
827
- ❌ **Don't use monotonically increasing shard keys**
828
- ❌ **Don't ignore document size limits** (16MB in MongoDB)
829
- ❌ **Don't fetch entire documents** - project only needed fields
830
- ❌ **Don't use $where or $regex without indexes**
831
- ❌ **Don't forget to validate data** at application level
832
- ❌ **Don't ignore replication lag** - use appropriate read preferences
833
- ❌ **Don't skip backups** - data loss is catastrophic
834
-
835
- ---
836
-
837
- ## Summary
838
-
839
- **Document stores are ideal for:**
840
- - Flexible schema requirements
841
- - Nested/hierarchical data
842
- - Read-heavy workloads
843
- - Horizontal scalability
844
-
845
- **Key patterns:**
846
- - **Embedding**: One-to-few relationships, data accessed together
847
- - **Referencing**: One-to-many relationships, data accessed independently
848
- - **Hybrid**: Combine embedding and referencing for optimal performance
849
-
850
- **Performance tips:**
851
- - Create indexes for queried fields
852
- - Use aggregation pipelines for complex queries
853
- - Limit and project results
854
- - Monitor with explain()
855
- - Shard for scale, replicate for availability
856
-
1
+ # NoSQL Document Stores
2
+
3
+ ## Overview
4
+
5
+ This document covers document store databases (MongoDB, CouchDB, Couchbase), including schema design patterns (embedding vs referencing), denormalization strategies, indexing, aggregation pipelines, transactions, sharding, replication, and query optimization.
6
+
7
+ ---
8
+
9
+ ## Document Store Fundamentals
10
+
11
+ ### What is a Document Store?
12
+
13
+ **Definition**: Database that stores data as documents (typically JSON/BSON)
14
+
15
+ **Characteristics:**
16
+ - Documents are self-contained units of data
17
+ - Flexible schema (each document can have different fields)
18
+ - Nested data structures (arrays, objects)
19
+ - Rich query capabilities
20
+ - Horizontal scalability
21
+
22
+ **Document Example:**
23
+ ```json
24
+ {
25
+ "_id": "507f1f77bcf86cd799439011",
26
+ "name": "John Doe",
27
+ "email": "john@example.com",
28
+ "age": 30,
29
+ "addresses": [
30
+ {
31
+ "type": "home",
32
+ "street": "123 Main St",
33
+ "city": "Boston",
34
+ "state": "MA",
35
+ "zip": "02101"
36
+ }
37
+ ],
38
+ "preferences": {
39
+ "newsletter": true,
40
+ "notifications": {
41
+ "email": true,
42
+ "sms": false
43
+ }
44
+ },
45
+ "created_at": "2024-01-15T10:00:00Z",
46
+ "updated_at": "2024-01-15T10:00:00Z"
47
+ }
48
+ ```
49
+
50
+ ### Popular Document Databases
51
+
52
+ **MongoDB:**
53
+ - Most popular document database
54
+ - BSON (Binary JSON) format
55
+ - Rich query language
56
+ - Aggregation framework
57
+ - Sharding and replication
58
+ - ACID transactions (4.0+)
59
+
60
+ **CouchDB:**
61
+ - HTTP/REST API
62
+ - Multi-version concurrency control (MVCC)
63
+ - Eventual consistency
64
+ - Master-master replication
65
+ - MapReduce views
66
+
67
+ **Couchbase:**
68
+ - Combines document store with key-value store
69
+ - N1QL query language (SQL-like)
70
+ - Built-in caching
71
+ - High performance
72
+ - Mobile sync (Couchbase Lite)
73
+
74
+ ---
75
+
76
+ ## Schema Design Patterns
77
+
78
+ ### Embedding vs Referencing
79
+
80
+ **Key Decision**: Should related data be embedded or referenced?
81
+
82
+ #### Embedding (Denormalization)
83
+
84
+ **Store related data within the same document:**
85
+
86
+ ```javascript
87
+ // User with embedded addresses
88
+ {
89
+ "_id": "user123",
90
+ "name": "John Doe",
91
+ "email": "john@example.com",
92
+ "addresses": [
93
+ { "type": "home", "street": "123 Main St", "city": "Boston" },
94
+ { "type": "work", "street": "456 Office Blvd", "city": "Cambridge" }
95
+ ],
96
+ "payment_methods": [
97
+ { "type": "credit_card", "last4": "1234", "brand": "Visa" },
98
+ { "type": "paypal", "email": "john@paypal.com" }
99
+ ]
100
+ }
101
+ ```
102
+
103
+ **Advantages:**
104
+ - ✅ Single query to retrieve all data
105
+ - ✅ Better read performance
106
+ - ✅ Atomic updates (single document)
107
+ - ✅ Data locality (related data stored together)
108
+
109
+ **Disadvantages:**
110
+ - ❌ Data duplication
111
+ - ❌ Document size limits (16MB in MongoDB)
112
+ - ❌ Difficult to query embedded data across documents
113
+ - ❌ Update complexity if data is duplicated
114
+
115
+ **When to embed:**
116
+ - ✅ One-to-few relationships (< 100 items)
117
+ - ✅ Data is always accessed together
118
+ - ✅ Data doesn't change frequently
119
+ - ✅ Embedded data is specific to parent document
120
+
121
+ #### Referencing (Normalization)
122
+
123
+ **Store references (IDs) to related data:**
124
+
125
+ ```javascript
126
+ // User document
127
+ {
128
+ "_id": "user123",
129
+ "name": "John Doe",
130
+ "email": "john@example.com"
131
+ }
132
+
133
+ // Address documents (separate collection)
134
+ {
135
+ "_id": "addr456",
136
+ "user_id": "user123",
137
+ "type": "home",
138
+ "street": "123 Main St",
139
+ "city": "Boston"
140
+ }
141
+
142
+ {
143
+ "_id": "addr789",
144
+ "user_id": "user123",
145
+ "type": "work",
146
+ "street": "456 Office Blvd",
147
+ "city": "Cambridge"
148
+ }
149
+ ```
150
+
151
+ **Advantages:**
152
+ - ✅ No data duplication
153
+ - ✅ Smaller document size
154
+ - ✅ Easier to query related data independently
155
+ - ✅ Easier to update (single location)
156
+
157
+ **Disadvantages:**
158
+ - ❌ Multiple queries required (application-level joins)
159
+ - ❌ Slower read performance
160
+ - ❌ No atomic updates across documents (without transactions)
161
+
162
+ **When to reference:**
163
+ - ✅ One-to-many or many-to-many relationships
164
+ - ✅ Data is accessed independently
165
+ - ✅ Data changes frequently
166
+ - ✅ Embedded data would exceed document size limits
167
+ - ✅ Data is shared across multiple documents
168
+
169
+ ### Hybrid Approach
170
+
171
+ **Combine embedding and referencing:**
172
+
173
+ ```javascript
174
+ // Blog post with embedded author summary + reference
175
+ {
176
+ "_id": "post123",
177
+ "title": "Introduction to NoSQL",
178
+ "content": "...",
179
+ "author": {
180
+ "id": "user456", // Reference to full user document
181
+ "name": "John Doe", // Embedded for display
182
+ "avatar_url": "..." // Embedded for display
183
+ },
184
+ "comments": [
185
+ {
186
+ "id": "comment789",
187
+ "author": {
188
+ "id": "user789",
189
+ "name": "Jane Smith"
190
+ },
191
+ "text": "Great article!",
192
+ "created_at": "2024-01-15T11:00:00Z"
193
+ }
194
+ ],
195
+ "tags": ["nosql", "mongodb", "databases"], // Embedded (small, static)
196
+ "category_id": "cat123", // Reference (shared across posts)
197
+ "created_at": "2024-01-15T10:00:00Z"
198
+ }
199
+ ```
200
+
201
+ **Benefits:**
202
+ - ✅ Fast reads (embedded display data)
203
+ - ✅ Consistent updates (reference to source of truth)
204
+ - ✅ Flexible querying
205
+
206
+ ### One-to-Many Relationships
207
+
208
+ **Pattern 1: Embed child in parent (one-to-few)**
209
+ ```javascript
210
+ // Order with embedded line items
211
+ {
212
+ "_id": "order123",
213
+ "customer_id": "user456",
214
+ "items": [
215
+ { "product_id": "prod789", "name": "Widget", "quantity": 2, "price": 10.00 },
216
+ { "product_id": "prod012", "name": "Gadget", "quantity": 1, "price": 25.00 }
217
+ ],
218
+ "total": 45.00,
219
+ "status": "shipped"
220
+ }
221
+ ```
222
+
223
+ **Pattern 2: Reference parent in child (one-to-many)**
224
+ ```javascript
225
+ // User document
226
+ { "_id": "user456", "name": "John Doe" }
227
+
228
+ // Order documents (many)
229
+ { "_id": "order123", "user_id": "user456", "total": 45.00 }
230
+ { "_id": "order124", "user_id": "user456", "total": 99.99 }
231
+ ```
232
+
233
+ **Pattern 3: Reference children in parent (one-to-many)**
234
+ ```javascript
235
+ // User with order references
236
+ {
237
+ "_id": "user456",
238
+ "name": "John Doe",
239
+ "order_ids": ["order123", "order124", "order125"]
240
+ }
241
+
242
+ // Order documents
243
+ { "_id": "order123", "total": 45.00 }
244
+ { "_id": "order124", "total": 99.99 }
245
+ ```
246
+
247
+ ### Many-to-Many Relationships
248
+
249
+ **Pattern 1: Embed array of references**
250
+ ```javascript
251
+ // Product with category references
252
+ {
253
+ "_id": "prod123",
254
+ "name": "Laptop",
255
+ "category_ids": ["cat_electronics", "cat_computers", "cat_office"]
256
+ }
257
+
258
+ // Category with product references
259
+ {
260
+ "_id": "cat_electronics",
261
+ "name": "Electronics",
262
+ "product_ids": ["prod123", "prod456", "prod789"]
263
+ }
264
+ ```
265
+
266
+ **Pattern 2: Junction collection**
267
+ ```javascript
268
+ // Product document
269
+ { "_id": "prod123", "name": "Laptop" }
270
+
271
+ // Category document
272
+ { "_id": "cat_electronics", "name": "Electronics" }
273
+
274
+ // ProductCategory junction
275
+ {
276
+ "_id": "pc123",
277
+ "product_id": "prod123",
278
+ "category_id": "cat_electronics",
279
+ "featured": true,
280
+ "sort_order": 1
281
+ }
282
+ ```
283
+
284
+ ---
285
+
286
+ ## Indexing
287
+
288
+ ### Index Types
289
+
290
+ **Single Field Index:**
291
+ ```javascript
292
+ // Create index on email field
293
+ db.users.createIndex({ email: 1 }); // 1 = ascending, -1 = descending
294
+
295
+ // Query uses index
296
+ db.users.find({ email: "john@example.com" });
297
+ ```
298
+
299
+ **Compound Index:**
300
+ ```javascript
301
+ // Create compound index
302
+ db.orders.createIndex({ user_id: 1, created_at: -1 });
303
+
304
+ // Queries that use this index
305
+ db.orders.find({ user_id: "user123" }).sort({ created_at: -1 });
306
+ db.orders.find({ user_id: "user123", created_at: { $gte: new Date("2024-01-01") } });
307
+ ```
308
+
309
+ **Multikey Index (Arrays):**
310
+ ```javascript
311
+ // Create index on array field
312
+ db.products.createIndex({ tags: 1 });
313
+
314
+ // Query uses index
315
+ db.products.find({ tags: "electronics" });
316
+ ```
317
+
318
+ **Text Index (Full-Text Search):**
319
+ ```javascript
320
+ // Create text index
321
+ db.articles.createIndex({ title: "text", content: "text" });
322
+
323
+ // Full-text search
324
+ db.articles.find({ $text: { $search: "mongodb tutorial" } });
325
+ ```
326
+
327
+ **Geospatial Index:**
328
+ ```javascript
329
+ // Create 2dsphere index for location data
330
+ db.places.createIndex({ location: "2dsphere" });
331
+
332
+ // Find places near coordinates
333
+ db.places.find({
334
+ location: {
335
+ $near: {
336
+ $geometry: { type: "Point", coordinates: [-73.97, 40.77] },
337
+ $maxDistance: 5000 // meters
338
+ }
339
+ }
340
+ });
341
+ ```
342
+
343
+ **Unique Index:**
344
+ ```javascript
345
+ // Create unique index
346
+ db.users.createIndex({ email: 1 }, { unique: true });
347
+
348
+ // Duplicate emails will be rejected
349
+ ```
350
+
351
+ **Partial Index:**
352
+ ```javascript
353
+ // Index only documents matching filter
354
+ db.orders.createIndex(
355
+ { user_id: 1, created_at: -1 },
356
+ { partialFilterExpression: { status: "active" } }
357
+ );
358
+
359
+ // Only indexes active orders
360
+ ```
361
+
362
+ **TTL Index (Time-To-Live):**
363
+ ```javascript
364
+ // Auto-delete documents after expiration
365
+ db.sessions.createIndex(
366
+ { created_at: 1 },
367
+ { expireAfterSeconds: 3600 } // Delete after 1 hour
368
+ );
369
+ ```
370
+
371
+ ### Index Best Practices
372
+
373
+ **DO:**
374
+ - ✅ Create indexes for frequently queried fields
375
+ - ✅ Use compound indexes for multi-field queries
376
+ - ✅ Create indexes before querying large collections
377
+ - ✅ Use covered queries (query only indexed fields)
378
+ - ✅ Monitor index usage with explain()
379
+ - ✅ Remove unused indexes
380
+
381
+ **DON'T:**
382
+ - ❌ Create too many indexes (slows writes)
383
+ - ❌ Index low-cardinality fields (few unique values)
384
+ - ❌ Forget to index foreign keys
385
+ - ❌ Create redundant indexes
386
+
387
+ ---
388
+
389
+ ## Aggregation Pipelines
390
+
391
+ ### What is Aggregation?
392
+
393
+ **Definition**: Process documents through a pipeline of stages to compute results
394
+
395
+ **Common stages:**
396
+ - `$match`: Filter documents
397
+ - `$group`: Group by field and compute aggregates
398
+ - `$project`: Select/transform fields
399
+ - `$sort`: Sort documents
400
+ - `$limit`: Limit number of documents
401
+ - `$skip`: Skip documents
402
+ - `$lookup`: Join with another collection
403
+ - `$unwind`: Deconstruct array field
404
+
405
+ ### Aggregation Examples
406
+
407
+ **Example 1: Group and count**
408
+ ```javascript
409
+ // Count orders by status
410
+ db.orders.aggregate([
411
+ { $group: { _id: "$status", count: { $sum: 1 } } },
412
+ { $sort: { count: -1 } }
413
+ ]);
414
+
415
+ // Result:
416
+ // [
417
+ // { "_id": "shipped", "count": 150 },
418
+ // { "_id": "pending", "count": 45 },
419
+ // { "_id": "cancelled", "count": 5 }
420
+ // ]
421
+ ```
422
+
423
+ **Example 2: Filter, group, and calculate**
424
+ ```javascript
425
+ // Total revenue by user for orders in 2024
426
+ db.orders.aggregate([
427
+ { $match: { created_at: { $gte: new Date("2024-01-01") } } },
428
+ { $group: {
429
+ _id: "$user_id",
430
+ total_revenue: { $sum: "$total" },
431
+ order_count: { $sum: 1 },
432
+ avg_order: { $avg: "$total" }
433
+ }
434
+ },
435
+ { $sort: { total_revenue: -1 } },
436
+ { $limit: 10 }
437
+ ]);
438
+ ```
439
+
440
+ **Example 3: Unwind array and group**
441
+ ```javascript
442
+ // Count products by tag
443
+ db.products.aggregate([
444
+ { $unwind: "$tags" },
445
+ { $group: { _id: "$tags", count: { $sum: 1 } } },
446
+ { $sort: { count: -1 } }
447
+ ]);
448
+ ```
449
+
450
+ **Example 4: Lookup (join)**
451
+ ```javascript
452
+ // Join orders with user data
453
+ db.orders.aggregate([
454
+ { $lookup: {
455
+ from: "users",
456
+ localField: "user_id",
457
+ foreignField: "_id",
458
+ as: "user"
459
+ }
460
+ },
461
+ { $unwind: "$user" },
462
+ { $project: {
463
+ order_id: "$_id",
464
+ total: 1,
465
+ user_name: "$user.name",
466
+ user_email: "$user.email"
467
+ }
468
+ }
469
+ ]);
470
+ ```
471
+
472
+ **Example 5: Complex aggregation with multiple stages**
473
+ ```javascript
474
+ // Top 5 customers by revenue with order details
475
+ db.orders.aggregate([
476
+ { $match: { status: "completed" } },
477
+ { $group: {
478
+ _id: "$user_id",
479
+ total_spent: { $sum: "$total" },
480
+ order_count: { $sum: 1 },
481
+ orders: { $push: { order_id: "$_id", total: "$total", date: "$created_at" } }
482
+ }
483
+ },
484
+ { $lookup: {
485
+ from: "users",
486
+ localField: "_id",
487
+ foreignField: "_id",
488
+ as: "user"
489
+ }
490
+ },
491
+ { $unwind: "$user" },
492
+ { $project: {
493
+ user_name: "$user.name",
494
+ user_email: "$user.email",
495
+ total_spent: 1,
496
+ order_count: 1,
497
+ avg_order: { $divide: ["$total_spent", "$order_count"] },
498
+ orders: 1
499
+ }
500
+ },
501
+ { $sort: { total_spent: -1 } },
502
+ { $limit: 5 }
503
+ ]);
504
+ ```
505
+
506
+ ---
507
+
508
+ ## Transactions
509
+
510
+ ### Multi-Document Transactions (MongoDB 4.0+)
511
+
512
+ **ACID transactions across multiple documents:**
513
+
514
+ ```javascript
515
+ const session = client.startSession();
516
+
517
+ try {
518
+ await session.withTransaction(async () => {
519
+ // Deduct from sender
520
+ await db.accounts.updateOne(
521
+ { _id: senderId },
522
+ { $inc: { balance: -amount } },
523
+ { session }
524
+ );
525
+
526
+ // Add to receiver
527
+ await db.accounts.updateOne(
528
+ { _id: receiverId },
529
+ { $inc: { balance: amount } },
530
+ { session }
531
+ );
532
+
533
+ // Log transaction
534
+ await db.transactions.insertOne({
535
+ from: senderId,
536
+ to: receiverId,
537
+ amount: amount,
538
+ timestamp: new Date()
539
+ }, { session });
540
+ });
541
+
542
+ console.log("Transaction committed");
543
+ } catch (error) {
544
+ console.log("Transaction aborted:", error);
545
+ } finally {
546
+ await session.endSession();
547
+ }
548
+ ```
549
+
550
+ ### Single-Document Atomicity
551
+
552
+ **All updates to a single document are atomic:**
553
+
554
+ ```javascript
555
+ // Atomic update - all fields updated together
556
+ db.orders.updateOne(
557
+ { _id: orderId },
558
+ {
559
+ $set: { status: "shipped", shipped_at: new Date() },
560
+ $inc: { version: 1 },
561
+ $push: { status_history: { status: "shipped", timestamp: new Date() } }
562
+ }
563
+ );
564
+ ```
565
+
566
+ ### Optimistic Concurrency Control
567
+
568
+ **Use version field to prevent conflicts:**
569
+
570
+ ```javascript
571
+ // Read document with version
572
+ const product = await db.products.findOne({ _id: productId });
573
+ const currentVersion = product.version;
574
+
575
+ // Update with version check
576
+ const result = await db.products.updateOne(
577
+ { _id: productId, version: currentVersion },
578
+ {
579
+ $set: { stock: product.stock - quantity },
580
+ $inc: { version: 1 }
581
+ }
582
+ );
583
+
584
+ if (result.modifiedCount === 0) {
585
+ throw new Error("Concurrent modification detected - retry");
586
+ }
587
+ ```
588
+
589
+ ---
590
+
591
+ ## Sharding
592
+
593
+ ### What is Sharding?
594
+
595
+ **Definition**: Horizontal partitioning of data across multiple servers
596
+
597
+ **Benefits:**
598
+ - ✅ Horizontal scalability
599
+ - ✅ Distribute load across servers
600
+ - ✅ Store more data than single server can handle
601
+
602
+ **Shard Key**: Field used to partition data
603
+
604
+ ### Choosing a Shard Key
605
+
606
+ **Good shard keys:**
607
+ - ✅ High cardinality (many unique values)
608
+ - ✅ Even distribution of data
609
+ - ✅ Supports common query patterns
610
+ - ✅ Rarely updated
611
+
612
+ **Bad shard keys:**
613
+ - ❌ Low cardinality (few unique values)
614
+ - ❌ Monotonically increasing (e.g., auto-increment ID, timestamp)
615
+ - ❌ Frequently updated
616
+
617
+ **Example: Shard by user_id**
618
+ ```javascript
619
+ // Enable sharding on database
620
+ sh.enableSharding("myapp");
621
+
622
+ // Shard collection by user_id
623
+ sh.shardCollection("myapp.orders", { user_id: 1 });
624
+
625
+ // Queries with user_id are routed to specific shard
626
+ db.orders.find({ user_id: "user123" }); // Targeted query
627
+
628
+ // Queries without user_id scan all shards
629
+ db.orders.find({ status: "pending" }); // Scatter-gather query
630
+ ```
631
+
632
+ **Example: Compound shard key**
633
+ ```javascript
634
+ // Shard by user_id and created_at
635
+ sh.shardCollection("myapp.events", { user_id: 1, created_at: 1 });
636
+
637
+ // Better distribution for time-series data
638
+ ```
639
+
640
+ ---
641
+
642
+ ## Replication
643
+
644
+ ### What is Replication?
645
+
646
+ **Definition**: Maintain multiple copies of data across servers
647
+
648
+ **Benefits:**
649
+ - ✅ High availability (failover)
650
+ - ✅ Data redundancy
651
+ - ✅ Read scalability (read from replicas)
652
+ - ✅ Disaster recovery
653
+
654
+ ### MongoDB Replica Set
655
+
656
+ **Architecture:**
657
+ - **Primary**: Accepts writes
658
+ - **Secondary**: Replicates from primary
659
+ - **Arbiter**: Participates in elections (no data)
660
+
661
+ **Example: Configure replica set**
662
+ ```javascript
663
+ // Initialize replica set
664
+ rs.initiate({
665
+ _id: "myReplicaSet",
666
+ members: [
667
+ { _id: 0, host: "mongo1:27017" },
668
+ { _id: 1, host: "mongo2:27017" },
669
+ { _id: 2, host: "mongo3:27017" }
670
+ ]
671
+ });
672
+
673
+ // Check status
674
+ rs.status();
675
+ ```
676
+
677
+ **Read Preferences:**
678
+ ```javascript
679
+ // Read from primary (default)
680
+ db.users.find().readPref("primary");
681
+
682
+ // Read from secondary (eventual consistency)
683
+ db.users.find().readPref("secondary");
684
+
685
+ // Read from primary preferred
686
+ db.users.find().readPref("primaryPreferred");
687
+
688
+ // Read from nearest (lowest latency)
689
+ db.users.find().readPref("nearest");
690
+ ```
691
+
692
+ **Write Concerns:**
693
+ ```javascript
694
+ // Wait for write to be acknowledged by majority
695
+ db.orders.insertOne(
696
+ { user_id: "user123", total: 99.99 },
697
+ { writeConcern: { w: "majority", wtimeout: 5000 } }
698
+ );
699
+
700
+ // Write to primary only (faster, less durable)
701
+ db.logs.insertOne(
702
+ { message: "User logged in" },
703
+ { writeConcern: { w: 1 } }
704
+ );
705
+ ```
706
+
707
+ ---
708
+
709
+ ## Query Optimization
710
+
711
+ ### Use Indexes
712
+
713
+ **Always create indexes for queried fields:**
714
+
715
+ ```javascript
716
+ // Create index
717
+ db.users.createIndex({ email: 1 });
718
+
719
+ // Query uses index
720
+ db.users.find({ email: "john@example.com" });
721
+ ```
722
+
723
+ ### Analyze Query Performance
724
+
725
+ **Use explain() to analyze queries:**
726
+
727
+ ```javascript
728
+ // Explain query execution
729
+ db.users.find({ email: "john@example.com" }).explain("executionStats");
730
+
731
+ // Look for:
732
+ // - "IXSCAN" (index scan) vs "COLLSCAN" (collection scan)
733
+ // - executionTimeMillis
734
+ // - totalDocsExamined vs nReturned
735
+ ```
736
+
737
+ ### Covered Queries
738
+
739
+ **Query only indexed fields (no document fetch):**
740
+
741
+ ```javascript
742
+ // Create index
743
+ db.users.createIndex({ email: 1, name: 1 });
744
+
745
+ // Covered query (only returns indexed fields)
746
+ db.users.find(
747
+ { email: "john@example.com" },
748
+ { _id: 0, email: 1, name: 1 }
749
+ );
750
+ ```
751
+
752
+ ### Limit Results
753
+
754
+ **Always limit results when possible:**
755
+
756
+ ```javascript
757
+ // Limit to 10 results
758
+ db.users.find({ status: "active" }).limit(10);
759
+
760
+ // Pagination
761
+ db.users.find({ status: "active" }).skip(20).limit(10);
762
+ ```
763
+
764
+ ### Project Only Needed Fields
765
+
766
+ **Don't fetch unnecessary fields:**
767
+
768
+ ```javascript
769
+ // ❌ BAD: Fetch entire document
770
+ db.users.find({ status: "active" });
771
+
772
+ // ✅ GOOD: Fetch only needed fields
773
+ db.users.find(
774
+ { status: "active" },
775
+ { name: 1, email: 1, _id: 0 }
776
+ );
777
+ ```
778
+
779
+ ### Avoid Large Documents
780
+
781
+ **Keep documents under 16MB (MongoDB limit):**
782
+
783
+ ```javascript
784
+ // ❌ BAD: Unbounded array growth
785
+ {
786
+ "_id": "user123",
787
+ "events": [/* thousands of events */]
788
+ }
789
+
790
+ // ✅ GOOD: Reference separate collection
791
+ {
792
+ "_id": "user123",
793
+ "name": "John Doe"
794
+ }
795
+
796
+ // Events in separate collection
797
+ {
798
+ "_id": "event456",
799
+ "user_id": "user123",
800
+ "type": "login",
801
+ "timestamp": "2024-01-15T10:00:00Z"
802
+ }
803
+ ```
804
+
805
+ ---
806
+
807
+ ## Best Practices
808
+
809
+ ### DO
810
+
811
+ ✅ **Design schema for your queries** (query-driven design)
812
+ ✅ **Use embedding for one-to-few relationships**
813
+ ✅ **Use referencing for one-to-many relationships**
814
+ ✅ **Create indexes for frequently queried fields**
815
+ ✅ **Use aggregation pipelines for complex queries**
816
+ ✅ **Implement schema validation** (MongoDB schema validation)
817
+ ✅ **Use transactions when needed** (MongoDB 4.0+)
818
+ ✅ **Monitor query performance** with explain()
819
+ ✅ **Shard for horizontal scalability**
820
+ ✅ **Replicate for high availability**
821
+
822
+ ### DON'T
823
+
824
+ ❌ **Don't over-normalize** - embrace denormalization
825
+ ❌ **Don't create unbounded arrays** - use separate collections
826
+ ❌ **Don't skip indexing** - queries will be slow
827
+ ❌ **Don't use monotonically increasing shard keys**
828
+ ❌ **Don't ignore document size limits** (16MB in MongoDB)
829
+ ❌ **Don't fetch entire documents** - project only needed fields
830
+ ❌ **Don't use $where or $regex without indexes**
831
+ ❌ **Don't forget to validate data** at application level
832
+ ❌ **Don't ignore replication lag** - use appropriate read preferences
833
+ ❌ **Don't skip backups** - data loss is catastrophic
834
+
835
+ ---
836
+
837
+ ## Summary
838
+
839
+ **Document stores are ideal for:**
840
+ - Flexible schema requirements
841
+ - Nested/hierarchical data
842
+ - Read-heavy workloads
843
+ - Horizontal scalability
844
+
845
+ **Key patterns:**
846
+ - **Embedding**: One-to-few relationships, data accessed together
847
+ - **Referencing**: One-to-many relationships, data accessed independently
848
+ - **Hybrid**: Combine embedding and referencing for optimal performance
849
+
850
+ **Performance tips:**
851
+ - Create indexes for queried fields
852
+ - Use aggregation pipelines for complex queries
853
+ - Limit and project results
854
+ - Monitor with explain()
855
+ - Shard for scale, replicate for availability
856
+