@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,697 +1,697 @@
1
- # Relational Databases
2
-
3
- ## Overview
4
-
5
- This document covers relational database fundamentals, SQL standards, database-specific features, ACID compliance, transaction management, connection handling, and when to use relational databases.
6
-
7
- ---
8
-
9
- ## When to Use Relational Databases
10
-
11
- ### Ideal Use Cases
12
-
13
- **Use relational databases when:**
14
- - ✅ Data has clear relationships and structure
15
- - ✅ ACID compliance is required
16
- - ✅ Complex queries with JOINs are needed
17
- - ✅ Data integrity is critical
18
- - ✅ Transactions are essential
19
- - ✅ Reporting and analytics are important
20
- - ✅ Schema is relatively stable
21
-
22
- **Examples:**
23
- - Financial systems (banking, accounting)
24
- - E-commerce platforms (orders, inventory)
25
- - CRM systems (customers, contacts)
26
- - ERP systems (resources, planning)
27
- - Content management systems
28
-
29
- ### When to Consider Alternatives
30
-
31
- **Consider NoSQL when:**
32
- - ❌ Schema changes frequently
33
- - ❌ Horizontal scaling is critical
34
- - ❌ Data is unstructured or semi-structured
35
- - ❌ Eventual consistency is acceptable
36
- - ❌ Simple key-value lookups dominate
37
- - ❌ Document-oriented data model fits better
38
-
39
- ---
40
-
41
- ## ACID Compliance
42
-
43
- ### ACID Properties
44
-
45
- #### Atomicity
46
-
47
- **Definition**: All operations in a transaction succeed or all fail
48
-
49
- ```sql
50
- -- Example: Transfer money between accounts
51
- BEGIN TRANSACTION;
52
-
53
- UPDATE accounts SET balance = balance - 100 WHERE id = 1;
54
- UPDATE accounts SET balance = balance + 100 WHERE id = 2;
55
-
56
- -- If either UPDATE fails, both are rolled back
57
- COMMIT;
58
- ```
59
-
60
- #### Consistency
61
-
62
- **Definition**: Database remains in valid state before and after transaction
63
-
64
- ```sql
65
- -- Example: Constraint ensures consistency
66
- ALTER TABLE accounts ADD CONSTRAINT check_balance CHECK (balance >= 0);
67
-
68
- -- This transaction will fail if it violates the constraint
69
- BEGIN TRANSACTION;
70
- UPDATE accounts SET balance = balance - 1000 WHERE id = 1;
71
- COMMIT; -- Fails if balance would go negative
72
- ```
73
-
74
- #### Isolation
75
-
76
- **Definition**: Concurrent transactions don't interfere with each other
77
-
78
- **Isolation Levels** (see `relational-transactions.md` for details):
79
- - Read Uncommitted
80
- - Read Committed (default in most databases)
81
- - Repeatable Read
82
- - Serializable
83
-
84
- #### Durability
85
-
86
- **Definition**: Committed transactions persist even after system failure
87
-
88
- **Implementation:**
89
- - Write-ahead logging (WAL)
90
- - Transaction logs
91
- - Checkpoints
92
- - Replication
93
-
94
- ---
95
-
96
- ## SQL Standards
97
-
98
- ### ANSI SQL Standards
99
-
100
- **Major versions:**
101
- - SQL-86 (SQL-87): First standard
102
- - SQL-92: Widely adopted baseline
103
- - SQL:1999: Added triggers, recursive queries
104
- - SQL:2003: Added window functions, XML
105
- - SQL:2011: Added temporal data
106
- - SQL:2016: Added JSON support
107
-
108
- ### Standard SQL Data Types
109
-
110
- ```sql
111
- -- Numeric types
112
- INTEGER, SMALLINT, BIGINT
113
- DECIMAL(precision, scale), NUMERIC(precision, scale)
114
- REAL, DOUBLE PRECISION
115
-
116
- -- Character types
117
- CHAR(n), VARCHAR(n)
118
- TEXT
119
-
120
- -- Date/time types
121
- DATE, TIME, TIMESTAMP
122
- INTERVAL
123
-
124
- -- Boolean
125
- BOOLEAN
126
-
127
- -- Binary
128
- BLOB, BYTEA
129
- ```
130
-
131
- ### Standard SQL Syntax
132
-
133
- ```sql
134
- -- SELECT statement
135
- SELECT column1, column2
136
- FROM table1
137
- JOIN table2 ON table1.id = table2.foreign_id
138
- WHERE condition
139
- GROUP BY column1
140
- HAVING aggregate_condition
141
- ORDER BY column1 DESC
142
- LIMIT 10 OFFSET 20;
143
-
144
- -- INSERT statement
145
- INSERT INTO table_name (column1, column2)
146
- VALUES (value1, value2);
147
-
148
- -- UPDATE statement
149
- UPDATE table_name
150
- SET column1 = value1, column2 = value2
151
- WHERE condition;
152
-
153
- -- DELETE statement
154
- DELETE FROM table_name
155
- WHERE condition;
156
- ```
157
-
158
- ---
159
-
160
- ## Database-Specific Features
161
-
162
- ### PostgreSQL
163
-
164
- **Strengths:**
165
- - Advanced data types (JSON, JSONB, arrays, hstore)
166
- - Full-text search
167
- - Geospatial data (PostGIS)
168
- - Advanced indexing (GiST, GIN, BRIN)
169
- - Window functions
170
- - CTEs and recursive queries
171
- - MVCC (Multi-Version Concurrency Control)
172
- - Extensibility (custom functions, types, operators)
173
-
174
- **Example: JSONB**
175
- ```sql
176
- -- PostgreSQL: Store and query JSON data
177
- CREATE TABLE products (
178
- id SERIAL PRIMARY KEY,
179
- name VARCHAR(255),
180
- attributes JSONB
181
- );
182
-
183
- INSERT INTO products (name, attributes)
184
- VALUES ('Laptop', '{"brand": "Dell", "ram": "16GB", "storage": "512GB SSD"}');
185
-
186
- -- Query JSON fields
187
- SELECT * FROM products
188
- WHERE attributes->>'brand' = 'Dell';
189
-
190
- -- Index JSON fields
191
- CREATE INDEX idx_products_brand ON products USING GIN ((attributes->'brand'));
192
- ```
193
-
194
- **Example: Arrays**
195
- ```sql
196
- -- PostgreSQL: Array data type
197
- CREATE TABLE posts (
198
- id SERIAL PRIMARY KEY,
199
- title VARCHAR(255),
200
- tags TEXT[]
201
- );
202
-
203
- INSERT INTO posts (title, tags)
204
- VALUES ('Database Guide', ARRAY['database', 'sql', 'postgresql']);
205
-
206
- -- Query arrays
207
- SELECT * FROM posts WHERE 'postgresql' = ANY(tags);
208
- ```
209
-
210
- **Example: Full-Text Search**
211
- ```sql
212
- -- PostgreSQL: Full-text search
213
- CREATE TABLE articles (
214
- id SERIAL PRIMARY KEY,
215
- title TEXT,
216
- content TEXT,
217
- search_vector tsvector
218
- );
219
-
220
- -- Create GIN index for full-text search
221
- CREATE INDEX idx_articles_search ON articles USING GIN(search_vector);
222
-
223
- -- Update search vector
224
- UPDATE articles
225
- SET search_vector = to_tsvector('english', title || ' ' || content);
226
-
227
- -- Search
228
- SELECT * FROM articles
229
- WHERE search_vector @@ to_tsquery('english', 'database & optimization');
230
- ```
231
-
232
- ### MySQL
233
-
234
- **Strengths:**
235
- - High performance for read-heavy workloads
236
- - Replication (master-slave, master-master)
237
- - Storage engines (InnoDB, MyISAM)
238
- - Partitioning
239
- - Full-text search
240
- - JSON support (MySQL 5.7+)
241
-
242
- **Example: Storage Engines**
243
- ```sql
244
- -- MySQL: InnoDB (default, supports transactions)
245
- CREATE TABLE orders (
246
- id INT AUTO_INCREMENT PRIMARY KEY,
247
- user_id INT NOT NULL,
248
- total DECIMAL(10, 2),
249
- created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
250
- ) ENGINE=InnoDB;
251
-
252
- -- MySQL: MyISAM (faster reads, no transactions)
253
- CREATE TABLE logs (
254
- id INT AUTO_INCREMENT PRIMARY KEY,
255
- message TEXT,
256
- created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
257
- ) ENGINE=MyISAM;
258
- ```
259
-
260
- **Example: JSON**
261
- ```sql
262
- -- MySQL: JSON data type
263
- CREATE TABLE users (
264
- id INT AUTO_INCREMENT PRIMARY KEY,
265
- name VARCHAR(255),
266
- preferences JSON
267
- );
268
-
269
- INSERT INTO users (name, preferences)
270
- VALUES ('John', '{"theme": "dark", "language": "en"}');
271
-
272
- -- Query JSON
273
- SELECT * FROM users
274
- WHERE JSON_EXTRACT(preferences, '$.theme') = 'dark';
275
- ```
276
-
277
- ### SQL Server
278
-
279
- **Strengths:**
280
- - Integration with Microsoft ecosystem
281
- - Advanced analytics (SQL Server Analysis Services)
282
- - Reporting (SQL Server Reporting Services)
283
- - Integration Services (ETL)
284
- - Columnstore indexes
285
- - In-memory OLTP
286
- - Temporal tables
287
-
288
- **Example: Temporal Tables**
289
- ```sql
290
- -- SQL Server: System-versioned temporal table
291
- CREATE TABLE employees (
292
- id INT PRIMARY KEY,
293
- name NVARCHAR(255),
294
- salary DECIMAL(10, 2),
295
- valid_from DATETIME2 GENERATED ALWAYS AS ROW START,
296
- valid_to DATETIME2 GENERATED ALWAYS AS ROW END,
297
- PERIOD FOR SYSTEM_TIME (valid_from, valid_to)
298
- ) WITH (SYSTEM_VERSIONING = ON);
299
-
300
- -- Query historical data
301
- SELECT * FROM employees
302
- FOR SYSTEM_TIME AS OF '2024-01-01';
303
- ```
304
-
305
- ### SQLite
306
-
307
- **Strengths:**
308
- - Embedded database (no server)
309
- - Zero configuration
310
- - Single file database
311
- - Cross-platform
312
- - ACID compliant
313
- - Small footprint
314
-
315
- **Use cases:**
316
- - Mobile applications
317
- - Desktop applications
318
- - Embedded systems
319
- - Testing and development
320
- - Small to medium websites
321
-
322
- **Example:**
323
- ```sql
324
- -- SQLite: Create database (single file)
325
- -- No server setup required
326
-
327
- CREATE TABLE settings (
328
- key TEXT PRIMARY KEY,
329
- value TEXT
330
- );
331
-
332
- INSERT INTO settings (key, value)
333
- VALUES ('theme', 'dark');
334
- ```
335
-
336
- ---
337
-
338
- ## Transaction Isolation Levels
339
-
340
- ### Overview
341
-
342
- **Isolation levels** control how transactions interact with each other.
343
-
344
- | Level | Dirty Read | Non-Repeatable Read | Phantom Read |
345
- |-------|-----------|---------------------|--------------|
346
- | Read Uncommitted | Yes | Yes | Yes |
347
- | Read Committed | No | Yes | Yes |
348
- | Repeatable Read | No | No | Yes |
349
- | Serializable | No | No | No |
350
-
351
- ### Setting Isolation Level
352
-
353
- ```sql
354
- -- PostgreSQL
355
- SET TRANSACTION ISOLATION LEVEL READ COMMITTED;
356
- SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;
357
- SET TRANSACTION ISOLATION LEVEL SERIALIZABLE;
358
-
359
- -- MySQL
360
- SET SESSION TRANSACTION ISOLATION LEVEL READ COMMITTED;
361
- SET SESSION TRANSACTION ISOLATION LEVEL REPEATABLE READ;
362
- SET SESSION TRANSACTION ISOLATION LEVEL SERIALIZABLE;
363
-
364
- -- SQL Server
365
- SET TRANSACTION ISOLATION LEVEL READ COMMITTED;
366
- SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;
367
- SET TRANSACTION ISOLATION LEVEL SERIALIZABLE;
368
- ```
369
-
370
- **See `relational-transactions.md` for detailed transaction management.**
371
-
372
- ---
373
-
374
- ## Connection Management
375
-
376
- ### Connection Pooling
377
-
378
- **Why use connection pooling:**
379
- - ✅ Reduces connection overhead
380
- - ✅ Improves performance
381
- - ✅ Limits concurrent connections
382
- - ✅ Reuses existing connections
383
-
384
- **Example: Node.js (pg pool)**
385
- ```javascript
386
- const { Pool } = require('pg');
387
-
388
- const pool = new Pool({
389
- host: 'localhost',
390
- port: 5432,
391
- database: 'mydb',
392
- user: 'myuser',
393
- password: 'mypassword',
394
- max: 20, // Maximum pool size
395
- idleTimeoutMillis: 30000, // Close idle clients after 30s
396
- connectionTimeoutMillis: 2000 // Return error after 2s if no connection available
397
- });
398
-
399
- // Use connection from pool
400
- async function getUser(id) {
401
- const client = await pool.connect();
402
- try {
403
- const result = await client.query('SELECT * FROM users WHERE id = $1', [id]);
404
- return result.rows[0];
405
- } finally {
406
- client.release(); // Return connection to pool
407
- }
408
- }
409
- ```
410
-
411
- **Example: Python (SQLAlchemy)**
412
- ```python
413
- from sqlalchemy import create_engine
414
- from sqlalchemy.pool import QueuePool
415
-
416
- engine = create_engine(
417
- 'postgresql://user:password@localhost/mydb',
418
- poolclass=QueuePool,
419
- pool_size=10, # Number of connections to maintain
420
- max_overflow=20, # Maximum overflow connections
421
- pool_timeout=30, # Timeout for getting connection
422
- pool_recycle=3600 # Recycle connections after 1 hour
423
- )
424
-
425
- # Use connection
426
- with engine.connect() as conn:
427
- result = conn.execute("SELECT * FROM users WHERE id = %s", (user_id,))
428
- user = result.fetchone()
429
- ```
430
-
431
- ### Connection Best Practices
432
-
433
- **DO:**
434
- - ✅ Use connection pooling
435
- - ✅ Set appropriate pool size (typically 10-20)
436
- - ✅ Set connection timeouts
437
- - ✅ Close connections when done
438
- - ✅ Handle connection errors gracefully
439
- - ✅ Monitor connection pool metrics
440
-
441
- **DON'T:**
442
- - ❌ Create new connection for each query
443
- - ❌ Leave connections open indefinitely
444
- - ❌ Set pool size too high (wastes resources)
445
- - ❌ Set pool size too low (causes bottlenecks)
446
- - ❌ Ignore connection pool exhaustion
447
-
448
- ---
449
-
450
- ## ORM vs Raw SQL
451
-
452
- ### Object-Relational Mapping (ORM)
453
-
454
- **Advantages:**
455
- - ✅ Database abstraction
456
- - ✅ Type safety
457
- - ✅ Automatic migrations
458
- - ✅ Reduced boilerplate
459
- - ✅ Protection against SQL injection
460
-
461
- **Disadvantages:**
462
- - ❌ Performance overhead
463
- - ❌ Complex queries can be difficult
464
- - ❌ Learning curve
465
- - ❌ Less control over SQL
466
-
467
- **Example: Prisma (TypeScript)**
468
- ```typescript
469
- // Define schema
470
- model User {
471
- id Int @id @default(autoincrement())
472
- email String @unique
473
- name String
474
- posts Post[]
475
- createdAt DateTime @default(now())
476
- }
477
-
478
- model Post {
479
- id Int @id @default(autoincrement())
480
- title String
481
- content String
482
- authorId Int
483
- author User @relation(fields: [authorId], references: [id])
484
- }
485
-
486
- // Query with ORM
487
- const user = await prisma.user.findUnique({
488
- where: { email: 'user@example.com' },
489
- include: { posts: true }
490
- });
491
- ```
492
-
493
- **Example: SQLAlchemy (Python)**
494
- ```python
495
- from sqlalchemy import Column, Integer, String, ForeignKey
496
- from sqlalchemy.orm import relationship, declarative_base
497
-
498
- Base = declarative_base()
499
-
500
- class User(Base):
501
- __tablename__ = 'users'
502
- id = Column(Integer, primary_key=True)
503
- email = Column(String, unique=True)
504
- name = Column(String)
505
- posts = relationship('Post', back_populates='author')
506
-
507
- class Post(Base):
508
- __tablename__ = 'posts'
509
- id = Column(Integer, primary_key=True)
510
- title = Column(String)
511
- content = Column(String)
512
- author_id = Column(Integer, ForeignKey('users.id'))
513
- author = relationship('User', back_populates='posts')
514
-
515
- # Query with ORM
516
- user = session.query(User).filter_by(email='user@example.com').first()
517
- ```
518
-
519
- ### Raw SQL
520
-
521
- **Advantages:**
522
- - ✅ Full control over queries
523
- - ✅ Better performance for complex queries
524
- - ✅ Database-specific features
525
- - ✅ Easier to optimize
526
-
527
- **Disadvantages:**
528
- - ❌ More boilerplate code
529
- - ❌ SQL injection risk (if not using prepared statements)
530
- - ❌ Database-specific syntax
531
- - ❌ Manual type mapping
532
-
533
- **Example: Raw SQL with Prepared Statements**
534
- ```javascript
535
- // Node.js (pg)
536
- const result = await client.query(
537
- 'SELECT * FROM users WHERE email = $1',
538
- ['user@example.com']
539
- );
540
-
541
- // Python (psycopg2)
542
- cursor.execute(
543
- 'SELECT * FROM users WHERE email = %s',
544
- ('user@example.com',)
545
- )
546
- ```
547
-
548
- ### When to Use Each
549
-
550
- **Use ORM when:**
551
- - ✅ Building CRUD applications
552
- - ✅ Schema changes frequently
553
- - ✅ Team prefers type safety
554
- - ✅ Simple to moderate queries
555
- - ✅ Database abstraction is valuable
556
-
557
- **Use Raw SQL when:**
558
- - ✅ Complex queries with multiple JOINs
559
- - ✅ Performance is critical
560
- - ✅ Using database-specific features
561
- - ✅ Reporting and analytics queries
562
- - ✅ Bulk operations
563
-
564
- **Hybrid Approach:**
565
- - Use ORM for most queries
566
- - Use raw SQL for complex/performance-critical queries
567
- - Most ORMs support raw SQL queries
568
-
569
- ---
570
-
571
- ## Common Patterns
572
-
573
- ### Repository Pattern
574
-
575
- **Encapsulate database access logic:**
576
-
577
- ```typescript
578
- // TypeScript: Repository pattern
579
- interface UserRepository {
580
- findById(id: number): Promise<User | null>;
581
- findByEmail(email: string): Promise<User | null>;
582
- create(user: CreateUserDto): Promise<User>;
583
- update(id: number, user: UpdateUserDto): Promise<User>;
584
- delete(id: number): Promise<void>;
585
- }
586
-
587
- class PrismaUserRepository implements UserRepository {
588
- constructor(private prisma: PrismaClient) {}
589
-
590
- async findById(id: number): Promise<User | null> {
591
- return this.prisma.user.findUnique({ where: { id } });
592
- }
593
-
594
- async findByEmail(email: string): Promise<User | null> {
595
- return this.prisma.user.findUnique({ where: { email } });
596
- }
597
-
598
- async create(user: CreateUserDto): Promise<User> {
599
- return this.prisma.user.create({ data: user });
600
- }
601
-
602
- async update(id: number, user: UpdateUserDto): Promise<User> {
603
- return this.prisma.user.update({ where: { id }, data: user });
604
- }
605
-
606
- async delete(id: number): Promise<void> {
607
- await this.prisma.user.delete({ where: { id } });
608
- }
609
- }
610
- ```
611
-
612
- ### Unit of Work Pattern
613
-
614
- **Manage transactions across multiple operations:**
615
-
616
- ```typescript
617
- // TypeScript: Unit of Work pattern
618
- class UnitOfWork {
619
- constructor(private prisma: PrismaClient) {}
620
-
621
- async execute<T>(work: (tx: PrismaClient) => Promise<T>): Promise<T> {
622
- return this.prisma.$transaction(async (tx) => {
623
- return work(tx);
624
- });
625
- }
626
- }
627
-
628
- // Usage
629
- const uow = new UnitOfWork(prisma);
630
- await uow.execute(async (tx) => {
631
- const user = await tx.user.create({ data: { email: 'user@example.com' } });
632
- await tx.post.create({ data: { title: 'First Post', authorId: user.id } });
633
- });
634
- ```
635
-
636
- ### Query Builder Pattern
637
-
638
- **Build queries programmatically:**
639
-
640
- ```typescript
641
- // TypeScript: Query builder (Knex.js)
642
- const users = await knex('users')
643
- .select('id', 'name', 'email')
644
- .where('status', 'active')
645
- .andWhere('created_at', '>', '2024-01-01')
646
- .orderBy('created_at', 'desc')
647
- .limit(10);
648
- ```
649
-
650
- ---
651
-
652
- ## Best Practices
653
-
654
- ### General Guidelines
655
-
656
- **DO:**
657
- - ✅ Use prepared statements to prevent SQL injection
658
- - ✅ Use connection pooling
659
- - ✅ Index foreign keys
660
- - ✅ Use transactions for multi-step operations
661
- - ✅ Handle errors gracefully
662
- - ✅ Monitor query performance
663
- - ✅ Use appropriate data types
664
- - ✅ Normalize data (see `relational-schema-design.md`)
665
- - ✅ Document complex queries
666
-
667
- **DON'T:**
668
- - ❌ Concatenate user input into SQL queries
669
- - ❌ Use SELECT * in production code
670
- - ❌ Create indexes on every column
671
- - ❌ Ignore transaction isolation levels
672
- - ❌ Store sensitive data unencrypted
673
- - ❌ Use NOLOCK hint without understanding implications
674
-
675
- ### Performance Tips
676
-
677
- - ✅ Use EXPLAIN/EXPLAIN ANALYZE to understand query plans
678
- - ✅ Create indexes on frequently queried columns
679
- - ✅ Avoid N+1 queries (use JOINs or batch loading)
680
- - ✅ Use pagination for large result sets
681
- - ✅ Cache frequently accessed data
682
- - ✅ Use database-specific optimizations
683
-
684
- **See `performance-optimization.md` for detailed performance guidelines.**
685
-
686
- ---
687
-
688
- ## Related Documentation
689
-
690
- - **relational-schema-design.md**: Schema design and normalization
691
- - **relational-indexing.md**: Indexing strategies
692
- - **relational-query-optimization.md**: Query optimization
693
- - **relational-transactions.md**: Transaction management
694
- - **security-standards.md**: Database security
695
- - **performance-optimization.md**: Performance tuning
696
- ```
697
-
1
+ # Relational Databases
2
+
3
+ ## Overview
4
+
5
+ This document covers relational database fundamentals, SQL standards, database-specific features, ACID compliance, transaction management, connection handling, and when to use relational databases.
6
+
7
+ ---
8
+
9
+ ## When to Use Relational Databases
10
+
11
+ ### Ideal Use Cases
12
+
13
+ **Use relational databases when:**
14
+ - ✅ Data has clear relationships and structure
15
+ - ✅ ACID compliance is required
16
+ - ✅ Complex queries with JOINs are needed
17
+ - ✅ Data integrity is critical
18
+ - ✅ Transactions are essential
19
+ - ✅ Reporting and analytics are important
20
+ - ✅ Schema is relatively stable
21
+
22
+ **Examples:**
23
+ - Financial systems (banking, accounting)
24
+ - E-commerce platforms (orders, inventory)
25
+ - CRM systems (customers, contacts)
26
+ - ERP systems (resources, planning)
27
+ - Content management systems
28
+
29
+ ### When to Consider Alternatives
30
+
31
+ **Consider NoSQL when:**
32
+ - ❌ Schema changes frequently
33
+ - ❌ Horizontal scaling is critical
34
+ - ❌ Data is unstructured or semi-structured
35
+ - ❌ Eventual consistency is acceptable
36
+ - ❌ Simple key-value lookups dominate
37
+ - ❌ Document-oriented data model fits better
38
+
39
+ ---
40
+
41
+ ## ACID Compliance
42
+
43
+ ### ACID Properties
44
+
45
+ #### Atomicity
46
+
47
+ **Definition**: All operations in a transaction succeed or all fail
48
+
49
+ ```sql
50
+ -- Example: Transfer money between accounts
51
+ BEGIN TRANSACTION;
52
+
53
+ UPDATE accounts SET balance = balance - 100 WHERE id = 1;
54
+ UPDATE accounts SET balance = balance + 100 WHERE id = 2;
55
+
56
+ -- If either UPDATE fails, both are rolled back
57
+ COMMIT;
58
+ ```
59
+
60
+ #### Consistency
61
+
62
+ **Definition**: Database remains in valid state before and after transaction
63
+
64
+ ```sql
65
+ -- Example: Constraint ensures consistency
66
+ ALTER TABLE accounts ADD CONSTRAINT check_balance CHECK (balance >= 0);
67
+
68
+ -- This transaction will fail if it violates the constraint
69
+ BEGIN TRANSACTION;
70
+ UPDATE accounts SET balance = balance - 1000 WHERE id = 1;
71
+ COMMIT; -- Fails if balance would go negative
72
+ ```
73
+
74
+ #### Isolation
75
+
76
+ **Definition**: Concurrent transactions don't interfere with each other
77
+
78
+ **Isolation Levels** (see `relational-transactions.md` for details):
79
+ - Read Uncommitted
80
+ - Read Committed (default in most databases)
81
+ - Repeatable Read
82
+ - Serializable
83
+
84
+ #### Durability
85
+
86
+ **Definition**: Committed transactions persist even after system failure
87
+
88
+ **Implementation:**
89
+ - Write-ahead logging (WAL)
90
+ - Transaction logs
91
+ - Checkpoints
92
+ - Replication
93
+
94
+ ---
95
+
96
+ ## SQL Standards
97
+
98
+ ### ANSI SQL Standards
99
+
100
+ **Major versions:**
101
+ - SQL-86 (SQL-87): First standard
102
+ - SQL-92: Widely adopted baseline
103
+ - SQL:1999: Added triggers, recursive queries
104
+ - SQL:2003: Added window functions, XML
105
+ - SQL:2011: Added temporal data
106
+ - SQL:2016: Added JSON support
107
+
108
+ ### Standard SQL Data Types
109
+
110
+ ```sql
111
+ -- Numeric types
112
+ INTEGER, SMALLINT, BIGINT
113
+ DECIMAL(precision, scale), NUMERIC(precision, scale)
114
+ REAL, DOUBLE PRECISION
115
+
116
+ -- Character types
117
+ CHAR(n), VARCHAR(n)
118
+ TEXT
119
+
120
+ -- Date/time types
121
+ DATE, TIME, TIMESTAMP
122
+ INTERVAL
123
+
124
+ -- Boolean
125
+ BOOLEAN
126
+
127
+ -- Binary
128
+ BLOB, BYTEA
129
+ ```
130
+
131
+ ### Standard SQL Syntax
132
+
133
+ ```sql
134
+ -- SELECT statement
135
+ SELECT column1, column2
136
+ FROM table1
137
+ JOIN table2 ON table1.id = table2.foreign_id
138
+ WHERE condition
139
+ GROUP BY column1
140
+ HAVING aggregate_condition
141
+ ORDER BY column1 DESC
142
+ LIMIT 10 OFFSET 20;
143
+
144
+ -- INSERT statement
145
+ INSERT INTO table_name (column1, column2)
146
+ VALUES (value1, value2);
147
+
148
+ -- UPDATE statement
149
+ UPDATE table_name
150
+ SET column1 = value1, column2 = value2
151
+ WHERE condition;
152
+
153
+ -- DELETE statement
154
+ DELETE FROM table_name
155
+ WHERE condition;
156
+ ```
157
+
158
+ ---
159
+
160
+ ## Database-Specific Features
161
+
162
+ ### PostgreSQL
163
+
164
+ **Strengths:**
165
+ - Advanced data types (JSON, JSONB, arrays, hstore)
166
+ - Full-text search
167
+ - Geospatial data (PostGIS)
168
+ - Advanced indexing (GiST, GIN, BRIN)
169
+ - Window functions
170
+ - CTEs and recursive queries
171
+ - MVCC (Multi-Version Concurrency Control)
172
+ - Extensibility (custom functions, types, operators)
173
+
174
+ **Example: JSONB**
175
+ ```sql
176
+ -- PostgreSQL: Store and query JSON data
177
+ CREATE TABLE products (
178
+ id SERIAL PRIMARY KEY,
179
+ name VARCHAR(255),
180
+ attributes JSONB
181
+ );
182
+
183
+ INSERT INTO products (name, attributes)
184
+ VALUES ('Laptop', '{"brand": "Dell", "ram": "16GB", "storage": "512GB SSD"}');
185
+
186
+ -- Query JSON fields
187
+ SELECT * FROM products
188
+ WHERE attributes->>'brand' = 'Dell';
189
+
190
+ -- Index JSON fields
191
+ CREATE INDEX idx_products_brand ON products USING GIN ((attributes->'brand'));
192
+ ```
193
+
194
+ **Example: Arrays**
195
+ ```sql
196
+ -- PostgreSQL: Array data type
197
+ CREATE TABLE posts (
198
+ id SERIAL PRIMARY KEY,
199
+ title VARCHAR(255),
200
+ tags TEXT[]
201
+ );
202
+
203
+ INSERT INTO posts (title, tags)
204
+ VALUES ('Database Guide', ARRAY['database', 'sql', 'postgresql']);
205
+
206
+ -- Query arrays
207
+ SELECT * FROM posts WHERE 'postgresql' = ANY(tags);
208
+ ```
209
+
210
+ **Example: Full-Text Search**
211
+ ```sql
212
+ -- PostgreSQL: Full-text search
213
+ CREATE TABLE articles (
214
+ id SERIAL PRIMARY KEY,
215
+ title TEXT,
216
+ content TEXT,
217
+ search_vector tsvector
218
+ );
219
+
220
+ -- Create GIN index for full-text search
221
+ CREATE INDEX idx_articles_search ON articles USING GIN(search_vector);
222
+
223
+ -- Update search vector
224
+ UPDATE articles
225
+ SET search_vector = to_tsvector('english', title || ' ' || content);
226
+
227
+ -- Search
228
+ SELECT * FROM articles
229
+ WHERE search_vector @@ to_tsquery('english', 'database & optimization');
230
+ ```
231
+
232
+ ### MySQL
233
+
234
+ **Strengths:**
235
+ - High performance for read-heavy workloads
236
+ - Replication (master-slave, master-master)
237
+ - Storage engines (InnoDB, MyISAM)
238
+ - Partitioning
239
+ - Full-text search
240
+ - JSON support (MySQL 5.7+)
241
+
242
+ **Example: Storage Engines**
243
+ ```sql
244
+ -- MySQL: InnoDB (default, supports transactions)
245
+ CREATE TABLE orders (
246
+ id INT AUTO_INCREMENT PRIMARY KEY,
247
+ user_id INT NOT NULL,
248
+ total DECIMAL(10, 2),
249
+ created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
250
+ ) ENGINE=InnoDB;
251
+
252
+ -- MySQL: MyISAM (faster reads, no transactions)
253
+ CREATE TABLE logs (
254
+ id INT AUTO_INCREMENT PRIMARY KEY,
255
+ message TEXT,
256
+ created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
257
+ ) ENGINE=MyISAM;
258
+ ```
259
+
260
+ **Example: JSON**
261
+ ```sql
262
+ -- MySQL: JSON data type
263
+ CREATE TABLE users (
264
+ id INT AUTO_INCREMENT PRIMARY KEY,
265
+ name VARCHAR(255),
266
+ preferences JSON
267
+ );
268
+
269
+ INSERT INTO users (name, preferences)
270
+ VALUES ('John', '{"theme": "dark", "language": "en"}');
271
+
272
+ -- Query JSON
273
+ SELECT * FROM users
274
+ WHERE JSON_EXTRACT(preferences, '$.theme') = 'dark';
275
+ ```
276
+
277
+ ### SQL Server
278
+
279
+ **Strengths:**
280
+ - Integration with Microsoft ecosystem
281
+ - Advanced analytics (SQL Server Analysis Services)
282
+ - Reporting (SQL Server Reporting Services)
283
+ - Integration Services (ETL)
284
+ - Columnstore indexes
285
+ - In-memory OLTP
286
+ - Temporal tables
287
+
288
+ **Example: Temporal Tables**
289
+ ```sql
290
+ -- SQL Server: System-versioned temporal table
291
+ CREATE TABLE employees (
292
+ id INT PRIMARY KEY,
293
+ name NVARCHAR(255),
294
+ salary DECIMAL(10, 2),
295
+ valid_from DATETIME2 GENERATED ALWAYS AS ROW START,
296
+ valid_to DATETIME2 GENERATED ALWAYS AS ROW END,
297
+ PERIOD FOR SYSTEM_TIME (valid_from, valid_to)
298
+ ) WITH (SYSTEM_VERSIONING = ON);
299
+
300
+ -- Query historical data
301
+ SELECT * FROM employees
302
+ FOR SYSTEM_TIME AS OF '2024-01-01';
303
+ ```
304
+
305
+ ### SQLite
306
+
307
+ **Strengths:**
308
+ - Embedded database (no server)
309
+ - Zero configuration
310
+ - Single file database
311
+ - Cross-platform
312
+ - ACID compliant
313
+ - Small footprint
314
+
315
+ **Use cases:**
316
+ - Mobile applications
317
+ - Desktop applications
318
+ - Embedded systems
319
+ - Testing and development
320
+ - Small to medium websites
321
+
322
+ **Example:**
323
+ ```sql
324
+ -- SQLite: Create database (single file)
325
+ -- No server setup required
326
+
327
+ CREATE TABLE settings (
328
+ key TEXT PRIMARY KEY,
329
+ value TEXT
330
+ );
331
+
332
+ INSERT INTO settings (key, value)
333
+ VALUES ('theme', 'dark');
334
+ ```
335
+
336
+ ---
337
+
338
+ ## Transaction Isolation Levels
339
+
340
+ ### Overview
341
+
342
+ **Isolation levels** control how transactions interact with each other.
343
+
344
+ | Level | Dirty Read | Non-Repeatable Read | Phantom Read |
345
+ |-------|-----------|---------------------|--------------|
346
+ | Read Uncommitted | Yes | Yes | Yes |
347
+ | Read Committed | No | Yes | Yes |
348
+ | Repeatable Read | No | No | Yes |
349
+ | Serializable | No | No | No |
350
+
351
+ ### Setting Isolation Level
352
+
353
+ ```sql
354
+ -- PostgreSQL
355
+ SET TRANSACTION ISOLATION LEVEL READ COMMITTED;
356
+ SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;
357
+ SET TRANSACTION ISOLATION LEVEL SERIALIZABLE;
358
+
359
+ -- MySQL
360
+ SET SESSION TRANSACTION ISOLATION LEVEL READ COMMITTED;
361
+ SET SESSION TRANSACTION ISOLATION LEVEL REPEATABLE READ;
362
+ SET SESSION TRANSACTION ISOLATION LEVEL SERIALIZABLE;
363
+
364
+ -- SQL Server
365
+ SET TRANSACTION ISOLATION LEVEL READ COMMITTED;
366
+ SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;
367
+ SET TRANSACTION ISOLATION LEVEL SERIALIZABLE;
368
+ ```
369
+
370
+ **See `relational-transactions.md` for detailed transaction management.**
371
+
372
+ ---
373
+
374
+ ## Connection Management
375
+
376
+ ### Connection Pooling
377
+
378
+ **Why use connection pooling:**
379
+ - ✅ Reduces connection overhead
380
+ - ✅ Improves performance
381
+ - ✅ Limits concurrent connections
382
+ - ✅ Reuses existing connections
383
+
384
+ **Example: Node.js (pg pool)**
385
+ ```javascript
386
+ const { Pool } = require('pg');
387
+
388
+ const pool = new Pool({
389
+ host: 'localhost',
390
+ port: 5432,
391
+ database: 'mydb',
392
+ user: 'myuser',
393
+ password: 'mypassword',
394
+ max: 20, // Maximum pool size
395
+ idleTimeoutMillis: 30000, // Close idle clients after 30s
396
+ connectionTimeoutMillis: 2000 // Return error after 2s if no connection available
397
+ });
398
+
399
+ // Use connection from pool
400
+ async function getUser(id) {
401
+ const client = await pool.connect();
402
+ try {
403
+ const result = await client.query('SELECT * FROM users WHERE id = $1', [id]);
404
+ return result.rows[0];
405
+ } finally {
406
+ client.release(); // Return connection to pool
407
+ }
408
+ }
409
+ ```
410
+
411
+ **Example: Python (SQLAlchemy)**
412
+ ```python
413
+ from sqlalchemy import create_engine
414
+ from sqlalchemy.pool import QueuePool
415
+
416
+ engine = create_engine(
417
+ 'postgresql://user:password@localhost/mydb',
418
+ poolclass=QueuePool,
419
+ pool_size=10, # Number of connections to maintain
420
+ max_overflow=20, # Maximum overflow connections
421
+ pool_timeout=30, # Timeout for getting connection
422
+ pool_recycle=3600 # Recycle connections after 1 hour
423
+ )
424
+
425
+ # Use connection
426
+ with engine.connect() as conn:
427
+ result = conn.execute("SELECT * FROM users WHERE id = %s", (user_id,))
428
+ user = result.fetchone()
429
+ ```
430
+
431
+ ### Connection Best Practices
432
+
433
+ **DO:**
434
+ - ✅ Use connection pooling
435
+ - ✅ Set appropriate pool size (typically 10-20)
436
+ - ✅ Set connection timeouts
437
+ - ✅ Close connections when done
438
+ - ✅ Handle connection errors gracefully
439
+ - ✅ Monitor connection pool metrics
440
+
441
+ **DON'T:**
442
+ - ❌ Create new connection for each query
443
+ - ❌ Leave connections open indefinitely
444
+ - ❌ Set pool size too high (wastes resources)
445
+ - ❌ Set pool size too low (causes bottlenecks)
446
+ - ❌ Ignore connection pool exhaustion
447
+
448
+ ---
449
+
450
+ ## ORM vs Raw SQL
451
+
452
+ ### Object-Relational Mapping (ORM)
453
+
454
+ **Advantages:**
455
+ - ✅ Database abstraction
456
+ - ✅ Type safety
457
+ - ✅ Automatic migrations
458
+ - ✅ Reduced boilerplate
459
+ - ✅ Protection against SQL injection
460
+
461
+ **Disadvantages:**
462
+ - ❌ Performance overhead
463
+ - ❌ Complex queries can be difficult
464
+ - ❌ Learning curve
465
+ - ❌ Less control over SQL
466
+
467
+ **Example: Prisma (TypeScript)**
468
+ ```typescript
469
+ // Define schema
470
+ model User {
471
+ id Int @id @default(autoincrement())
472
+ email String @unique
473
+ name String
474
+ posts Post[]
475
+ createdAt DateTime @default(now())
476
+ }
477
+
478
+ model Post {
479
+ id Int @id @default(autoincrement())
480
+ title String
481
+ content String
482
+ authorId Int
483
+ author User @relation(fields: [authorId], references: [id])
484
+ }
485
+
486
+ // Query with ORM
487
+ const user = await prisma.user.findUnique({
488
+ where: { email: 'user@example.com' },
489
+ include: { posts: true }
490
+ });
491
+ ```
492
+
493
+ **Example: SQLAlchemy (Python)**
494
+ ```python
495
+ from sqlalchemy import Column, Integer, String, ForeignKey
496
+ from sqlalchemy.orm import relationship, declarative_base
497
+
498
+ Base = declarative_base()
499
+
500
+ class User(Base):
501
+ __tablename__ = 'users'
502
+ id = Column(Integer, primary_key=True)
503
+ email = Column(String, unique=True)
504
+ name = Column(String)
505
+ posts = relationship('Post', back_populates='author')
506
+
507
+ class Post(Base):
508
+ __tablename__ = 'posts'
509
+ id = Column(Integer, primary_key=True)
510
+ title = Column(String)
511
+ content = Column(String)
512
+ author_id = Column(Integer, ForeignKey('users.id'))
513
+ author = relationship('User', back_populates='posts')
514
+
515
+ # Query with ORM
516
+ user = session.query(User).filter_by(email='user@example.com').first()
517
+ ```
518
+
519
+ ### Raw SQL
520
+
521
+ **Advantages:**
522
+ - ✅ Full control over queries
523
+ - ✅ Better performance for complex queries
524
+ - ✅ Database-specific features
525
+ - ✅ Easier to optimize
526
+
527
+ **Disadvantages:**
528
+ - ❌ More boilerplate code
529
+ - ❌ SQL injection risk (if not using prepared statements)
530
+ - ❌ Database-specific syntax
531
+ - ❌ Manual type mapping
532
+
533
+ **Example: Raw SQL with Prepared Statements**
534
+ ```javascript
535
+ // Node.js (pg)
536
+ const result = await client.query(
537
+ 'SELECT * FROM users WHERE email = $1',
538
+ ['user@example.com']
539
+ );
540
+
541
+ // Python (psycopg2)
542
+ cursor.execute(
543
+ 'SELECT * FROM users WHERE email = %s',
544
+ ('user@example.com',)
545
+ )
546
+ ```
547
+
548
+ ### When to Use Each
549
+
550
+ **Use ORM when:**
551
+ - ✅ Building CRUD applications
552
+ - ✅ Schema changes frequently
553
+ - ✅ Team prefers type safety
554
+ - ✅ Simple to moderate queries
555
+ - ✅ Database abstraction is valuable
556
+
557
+ **Use Raw SQL when:**
558
+ - ✅ Complex queries with multiple JOINs
559
+ - ✅ Performance is critical
560
+ - ✅ Using database-specific features
561
+ - ✅ Reporting and analytics queries
562
+ - ✅ Bulk operations
563
+
564
+ **Hybrid Approach:**
565
+ - Use ORM for most queries
566
+ - Use raw SQL for complex/performance-critical queries
567
+ - Most ORMs support raw SQL queries
568
+
569
+ ---
570
+
571
+ ## Common Patterns
572
+
573
+ ### Repository Pattern
574
+
575
+ **Encapsulate database access logic:**
576
+
577
+ ```typescript
578
+ // TypeScript: Repository pattern
579
+ interface UserRepository {
580
+ findById(id: number): Promise<User | null>;
581
+ findByEmail(email: string): Promise<User | null>;
582
+ create(user: CreateUserDto): Promise<User>;
583
+ update(id: number, user: UpdateUserDto): Promise<User>;
584
+ delete(id: number): Promise<void>;
585
+ }
586
+
587
+ class PrismaUserRepository implements UserRepository {
588
+ constructor(private prisma: PrismaClient) {}
589
+
590
+ async findById(id: number): Promise<User | null> {
591
+ return this.prisma.user.findUnique({ where: { id } });
592
+ }
593
+
594
+ async findByEmail(email: string): Promise<User | null> {
595
+ return this.prisma.user.findUnique({ where: { email } });
596
+ }
597
+
598
+ async create(user: CreateUserDto): Promise<User> {
599
+ return this.prisma.user.create({ data: user });
600
+ }
601
+
602
+ async update(id: number, user: UpdateUserDto): Promise<User> {
603
+ return this.prisma.user.update({ where: { id }, data: user });
604
+ }
605
+
606
+ async delete(id: number): Promise<void> {
607
+ await this.prisma.user.delete({ where: { id } });
608
+ }
609
+ }
610
+ ```
611
+
612
+ ### Unit of Work Pattern
613
+
614
+ **Manage transactions across multiple operations:**
615
+
616
+ ```typescript
617
+ // TypeScript: Unit of Work pattern
618
+ class UnitOfWork {
619
+ constructor(private prisma: PrismaClient) {}
620
+
621
+ async execute<T>(work: (tx: PrismaClient) => Promise<T>): Promise<T> {
622
+ return this.prisma.$transaction(async (tx) => {
623
+ return work(tx);
624
+ });
625
+ }
626
+ }
627
+
628
+ // Usage
629
+ const uow = new UnitOfWork(prisma);
630
+ await uow.execute(async (tx) => {
631
+ const user = await tx.user.create({ data: { email: 'user@example.com' } });
632
+ await tx.post.create({ data: { title: 'First Post', authorId: user.id } });
633
+ });
634
+ ```
635
+
636
+ ### Query Builder Pattern
637
+
638
+ **Build queries programmatically:**
639
+
640
+ ```typescript
641
+ // TypeScript: Query builder (Knex.js)
642
+ const users = await knex('users')
643
+ .select('id', 'name', 'email')
644
+ .where('status', 'active')
645
+ .andWhere('created_at', '>', '2024-01-01')
646
+ .orderBy('created_at', 'desc')
647
+ .limit(10);
648
+ ```
649
+
650
+ ---
651
+
652
+ ## Best Practices
653
+
654
+ ### General Guidelines
655
+
656
+ **DO:**
657
+ - ✅ Use prepared statements to prevent SQL injection
658
+ - ✅ Use connection pooling
659
+ - ✅ Index foreign keys
660
+ - ✅ Use transactions for multi-step operations
661
+ - ✅ Handle errors gracefully
662
+ - ✅ Monitor query performance
663
+ - ✅ Use appropriate data types
664
+ - ✅ Normalize data (see `relational-schema-design.md`)
665
+ - ✅ Document complex queries
666
+
667
+ **DON'T:**
668
+ - ❌ Concatenate user input into SQL queries
669
+ - ❌ Use SELECT * in production code
670
+ - ❌ Create indexes on every column
671
+ - ❌ Ignore transaction isolation levels
672
+ - ❌ Store sensitive data unencrypted
673
+ - ❌ Use NOLOCK hint without understanding implications
674
+
675
+ ### Performance Tips
676
+
677
+ - ✅ Use EXPLAIN/EXPLAIN ANALYZE to understand query plans
678
+ - ✅ Create indexes on frequently queried columns
679
+ - ✅ Avoid N+1 queries (use JOINs or batch loading)
680
+ - ✅ Use pagination for large result sets
681
+ - ✅ Cache frequently accessed data
682
+ - ✅ Use database-specific optimizations
683
+
684
+ **See `performance-optimization.md` for detailed performance guidelines.**
685
+
686
+ ---
687
+
688
+ ## Related Documentation
689
+
690
+ - **relational-schema-design.md**: Schema design and normalization
691
+ - **relational-indexing.md**: Indexing strategies
692
+ - **relational-query-optimization.md**: Query optimization
693
+ - **relational-transactions.md**: Transaction management
694
+ - **security-standards.md**: Database security
695
+ - **performance-optimization.md**: Performance tuning
696
+ ```
697
+