aigroup-workflow 2.2.1 → 2.2.3

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 (653) hide show
  1. package/.claude/commands/fix-build.md +10 -5
  2. package/.claude/commands/init-project.md +13 -8
  3. package/.claude/commands/plan.md +15 -8
  4. package/.claude/commands/review.md +12 -6
  5. package/.claude/commands/tdd.md +11 -5
  6. package/.claude/commands/workflow-start.md +20 -11
  7. package/.claude/settings.json +28 -0
  8. package/.codex/agents/architect.toml +207 -0
  9. package/.codex/agents/build-error-resolver.toml +110 -0
  10. package/.codex/agents/code-reviewer.toml +233 -0
  11. package/.codex/agents/doc-updater.toml +103 -0
  12. package/.codex/agents/e2e-runner.toml +103 -0
  13. package/.codex/agents/get-current-datetime.toml +23 -0
  14. package/.codex/agents/init-architect.toml +181 -0
  15. package/.codex/agents/planner.toml +208 -0
  16. package/.codex/agents/refactor-cleaner.toml +81 -0
  17. package/.codex/agents/rust-reviewer.toml +90 -0
  18. package/.codex/agents/security-reviewer.toml +104 -0
  19. package/.codex/agents/tdd-guide.toml +87 -0
  20. package/.codex/config.toml +22 -39
  21. package/AGENTS.md +2 -2
  22. package/CLAUDE.md +23 -1
  23. package/LICENSE +20 -20
  24. package/README.md +333 -333
  25. package/agents/a11y-architect.md +141 -141
  26. package/agents/architect.md +211 -211
  27. package/agents/build-error-resolver.md +114 -114
  28. package/agents/chief-of-staff.md +151 -151
  29. package/agents/code-architect.md +71 -71
  30. package/agents/code-explorer.md +69 -69
  31. package/agents/code-reviewer.md +237 -237
  32. package/agents/code-simplifier.md +47 -47
  33. package/agents/comment-analyzer.md +45 -45
  34. package/agents/conversation-analyzer.md +52 -52
  35. package/agents/cpp-build-resolver.md +90 -90
  36. package/agents/cpp-reviewer.md +72 -72
  37. package/agents/csharp-reviewer.md +101 -101
  38. package/agents/dart-build-resolver.md +201 -201
  39. package/agents/database-reviewer.md +91 -91
  40. package/agents/doc-updater.md +107 -107
  41. package/agents/docs-lookup.md +68 -68
  42. package/agents/e2e-runner.md +107 -107
  43. package/agents/flutter-reviewer.md +243 -243
  44. package/agents/gan-evaluator.md +209 -209
  45. package/agents/gan-generator.md +131 -131
  46. package/agents/gan-planner.md +99 -99
  47. package/agents/get-current-datetime.md +26 -26
  48. package/agents/go-build-resolver.md +94 -94
  49. package/agents/go-reviewer.md +76 -76
  50. package/agents/harness-optimizer.md +35 -35
  51. package/agents/healthcare-reviewer.md +83 -83
  52. package/agents/java-build-resolver.md +153 -153
  53. package/agents/java-reviewer.md +92 -92
  54. package/agents/kotlin-build-resolver.md +118 -118
  55. package/agents/kotlin-reviewer.md +159 -159
  56. package/agents/loop-operator.md +36 -36
  57. package/agents/opensource-forker.md +198 -198
  58. package/agents/opensource-packager.md +249 -249
  59. package/agents/opensource-sanitizer.md +188 -188
  60. package/agents/performance-optimizer.md +446 -446
  61. package/agents/planner.md +212 -212
  62. package/agents/pr-test-analyzer.md +45 -45
  63. package/agents/python-reviewer.md +98 -98
  64. package/agents/pytorch-build-resolver.md +120 -120
  65. package/agents/refactor-cleaner.md +85 -85
  66. package/agents/rust-build-resolver.md +148 -148
  67. package/agents/rust-reviewer.md +94 -94
  68. package/agents/security-reviewer.md +108 -108
  69. package/agents/seo-specialist.md +59 -59
  70. package/agents/silent-failure-hunter.md +50 -50
  71. package/agents/tdd-guide.md +91 -91
  72. package/agents/type-design-analyzer.md +41 -41
  73. package/agents/typescript-reviewer.md +112 -112
  74. package/cli/commands/update.mjs +1 -1
  75. package/cli/utils/scaffold.mjs +53 -0
  76. package/docs/rules/agents.md +166 -50
  77. package/docs/rules/cpp/coding-style.md +44 -44
  78. package/docs/rules/cpp/hooks.md +39 -39
  79. package/docs/rules/cpp/patterns.md +51 -51
  80. package/docs/rules/cpp/security.md +51 -51
  81. package/docs/rules/cpp/testing.md +44 -44
  82. package/docs/rules/csharp/coding-style.md +72 -72
  83. package/docs/rules/csharp/hooks.md +25 -25
  84. package/docs/rules/csharp/patterns.md +50 -50
  85. package/docs/rules/csharp/security.md +58 -58
  86. package/docs/rules/csharp/testing.md +46 -46
  87. package/docs/rules/dart/coding-style.md +159 -159
  88. package/docs/rules/dart/hooks.md +66 -66
  89. package/docs/rules/dart/patterns.md +261 -261
  90. package/docs/rules/dart/security.md +135 -135
  91. package/docs/rules/dart/testing.md +215 -215
  92. package/docs/rules/golang/coding-style.md +32 -32
  93. package/docs/rules/golang/hooks.md +17 -17
  94. package/docs/rules/golang/patterns.md +45 -45
  95. package/docs/rules/golang/security.md +34 -34
  96. package/docs/rules/golang/testing.md +31 -31
  97. package/docs/rules/java/coding-style.md +114 -114
  98. package/docs/rules/java/hooks.md +18 -18
  99. package/docs/rules/java/patterns.md +146 -146
  100. package/docs/rules/java/security.md +100 -100
  101. package/docs/rules/java/testing.md +131 -131
  102. package/docs/rules/java_zn/coding-style.md +169 -0
  103. package/docs/rules/java_zn/mybatis.md +102 -0
  104. package/docs/rules/kotlin/coding-style.md +86 -86
  105. package/docs/rules/kotlin/hooks.md +17 -17
  106. package/docs/rules/kotlin/patterns.md +146 -146
  107. package/docs/rules/kotlin/security.md +82 -82
  108. package/docs/rules/kotlin/testing.md +128 -128
  109. package/docs/rules/perl/coding-style.md +46 -46
  110. package/docs/rules/perl/hooks.md +22 -22
  111. package/docs/rules/perl/patterns.md +76 -76
  112. package/docs/rules/perl/security.md +69 -69
  113. package/docs/rules/perl/testing.md +54 -54
  114. package/docs/rules/php/coding-style.md +40 -40
  115. package/docs/rules/php/hooks.md +24 -24
  116. package/docs/rules/php/patterns.md +33 -33
  117. package/docs/rules/php/security.md +37 -37
  118. package/docs/rules/php/testing.md +39 -39
  119. package/docs/rules/python/coding-style.md +42 -42
  120. package/docs/rules/python/hooks.md +19 -19
  121. package/docs/rules/python/patterns.md +39 -39
  122. package/docs/rules/python/security.md +30 -30
  123. package/docs/rules/python/testing.md +38 -38
  124. package/docs/rules/rust/coding-style.md +151 -151
  125. package/docs/rules/rust/hooks.md +16 -16
  126. package/docs/rules/rust/patterns.md +168 -168
  127. package/docs/rules/rust/security.md +141 -141
  128. package/docs/rules/rust/testing.md +154 -154
  129. package/docs/rules/swift/coding-style.md +47 -47
  130. package/docs/rules/swift/hooks.md +20 -20
  131. package/docs/rules/swift/patterns.md +66 -66
  132. package/docs/rules/swift/security.md +33 -33
  133. package/docs/rules/swift/testing.md +45 -45
  134. package/docs/rules/typescript/coding-style.md +199 -199
  135. package/docs/rules/typescript/hooks.md +22 -22
  136. package/docs/rules/typescript/patterns.md +52 -52
  137. package/docs/rules/typescript/security.md +28 -28
  138. package/docs/rules/typescript/testing.md +18 -18
  139. package/docs/rules/web/coding-style.md +96 -96
  140. package/docs/rules/web/design-quality.md +62 -62
  141. package/docs/rules/web/hooks.md +120 -120
  142. package/docs/rules/web/patterns.md +79 -79
  143. package/docs/rules/web/performance.md +64 -64
  144. package/docs/rules/web/security.md +57 -57
  145. package/docs/rules/web/testing.md +55 -55
  146. package/docs/templates/README.md +36 -36
  147. package/docs/templates/ai-project-final.md +124 -124
  148. package/docs/templates/ai-project.md +105 -105
  149. package/docs/templates/api.md +157 -157
  150. package/docs/templates/bug.md +62 -62
  151. package/docs/templates/code-review.md +87 -87
  152. package/docs/templates/generic.md +116 -116
  153. package/docs/templates/implementation-plan.md +1 -1
  154. package/docs/templates/meeting.md +68 -68
  155. package/docs/templates/prd.md +98 -98
  156. package/docs/templates/ui.md +134 -134
  157. package/docs/workflow-pipeline.md +5 -5
  158. package/package.json +40 -39
  159. package/skills/SUPERPOWERS-LICENSE +21 -21
  160. package/skills/ai-ml/fine-tuning-expert/SKILL.md +162 -162
  161. package/skills/ai-ml/fine-tuning-expert/references/dataset-preparation.md +540 -540
  162. package/skills/ai-ml/fine-tuning-expert/references/deployment-optimization.md +673 -673
  163. package/skills/ai-ml/fine-tuning-expert/references/evaluation-metrics.md +597 -597
  164. package/skills/ai-ml/fine-tuning-expert/references/hyperparameter-tuning.md +565 -565
  165. package/skills/ai-ml/fine-tuning-expert/references/lora-peft.md +347 -347
  166. package/skills/ai-ml/ml-pipeline/SKILL.md +159 -159
  167. package/skills/ai-ml/ml-pipeline/references/experiment-tracking.md +833 -833
  168. package/skills/ai-ml/ml-pipeline/references/feature-engineering.md +631 -631
  169. package/skills/ai-ml/ml-pipeline/references/model-validation.md +978 -978
  170. package/skills/ai-ml/ml-pipeline/references/pipeline-orchestration.md +907 -907
  171. package/skills/ai-ml/ml-pipeline/references/training-pipelines.md +782 -782
  172. package/skills/ai-ml/rag-architect/SKILL.md +194 -194
  173. package/skills/ai-ml/rag-architect/references/chunking-strategies.md +878 -878
  174. package/skills/ai-ml/rag-architect/references/embedding-models.md +561 -561
  175. package/skills/ai-ml/rag-architect/references/rag-evaluation.md +833 -833
  176. package/skills/ai-ml/rag-architect/references/retrieval-optimization.md +795 -795
  177. package/skills/ai-ml/rag-architect/references/vector-databases.md +589 -589
  178. package/skills/ai-ml/spark-engineer/SKILL.md +148 -148
  179. package/skills/ai-ml/spark-engineer/references/partitioning-caching.md +543 -543
  180. package/skills/ai-ml/spark-engineer/references/performance-tuning.md +544 -544
  181. package/skills/ai-ml/spark-engineer/references/rdd-operations.md +599 -599
  182. package/skills/ai-ml/spark-engineer/references/spark-sql-dataframes.md +474 -474
  183. package/skills/ai-ml/spark-engineer/references/streaming-patterns.md +786 -786
  184. package/skills/backend/api-designer/SKILL.md +217 -217
  185. package/skills/backend/api-designer/references/error-handling.md +541 -541
  186. package/skills/backend/api-designer/references/openapi.md +824 -824
  187. package/skills/backend/api-designer/references/pagination.md +494 -494
  188. package/skills/backend/api-designer/references/rest-patterns.md +335 -335
  189. package/skills/backend/api-designer/references/versioning.md +391 -391
  190. package/skills/backend/architecture-designer/SKILL.md +117 -117
  191. package/skills/backend/architecture-designer/references/adr-template.md +116 -116
  192. package/skills/backend/architecture-designer/references/architecture-patterns.md +111 -111
  193. package/skills/backend/architecture-designer/references/database-selection.md +102 -102
  194. package/skills/backend/architecture-designer/references/nfr-checklist.md +112 -112
  195. package/skills/backend/architecture-designer/references/system-design.md +100 -100
  196. package/skills/backend/code-documenter/SKILL.md +147 -147
  197. package/skills/backend/code-documenter/references/api-docs-fastapi-django.md +166 -166
  198. package/skills/backend/code-documenter/references/api-docs-nestjs-express.md +220 -220
  199. package/skills/backend/code-documenter/references/coverage-reports.md +125 -125
  200. package/skills/backend/code-documenter/references/documentation-systems.md +333 -333
  201. package/skills/backend/code-documenter/references/interactive-api-docs.md +531 -531
  202. package/skills/backend/code-documenter/references/python-docstrings.md +121 -121
  203. package/skills/backend/code-documenter/references/typescript-jsdoc.md +145 -145
  204. package/skills/backend/code-documenter/references/user-guides-tutorials.md +530 -530
  205. package/skills/backend/debugging-wizard/SKILL.md +105 -105
  206. package/skills/backend/debugging-wizard/references/common-patterns.md +132 -132
  207. package/skills/backend/debugging-wizard/references/debugging-tools.md +140 -140
  208. package/skills/backend/debugging-wizard/references/quick-fixes.md +177 -177
  209. package/skills/backend/debugging-wizard/references/strategies.md +142 -142
  210. package/skills/backend/debugging-wizard/references/systematic-debugging.md +367 -367
  211. package/skills/backend/feature-forge/SKILL.md +98 -98
  212. package/skills/backend/feature-forge/references/acceptance-criteria.md +104 -104
  213. package/skills/backend/feature-forge/references/ears-syntax.md +99 -99
  214. package/skills/backend/feature-forge/references/interview-questions.md +150 -150
  215. package/skills/backend/feature-forge/references/pre-discovery-subagents.md +54 -54
  216. package/skills/backend/feature-forge/references/specification-template.md +103 -103
  217. package/skills/backend/fullstack-guardian/SKILL.md +105 -105
  218. package/skills/backend/fullstack-guardian/references/api-design-standards.md +307 -307
  219. package/skills/backend/fullstack-guardian/references/architecture-decisions.md +350 -350
  220. package/skills/backend/fullstack-guardian/references/backend-patterns.md +237 -237
  221. package/skills/backend/fullstack-guardian/references/common-patterns.md +134 -134
  222. package/skills/backend/fullstack-guardian/references/deliverables-checklist.md +354 -354
  223. package/skills/backend/fullstack-guardian/references/design-template.md +91 -91
  224. package/skills/backend/fullstack-guardian/references/error-handling.md +135 -135
  225. package/skills/backend/fullstack-guardian/references/frontend-patterns.md +340 -340
  226. package/skills/backend/fullstack-guardian/references/integration-patterns.md +333 -333
  227. package/skills/backend/fullstack-guardian/references/security-checklist.md +106 -106
  228. package/skills/backend/graphql-architect/SKILL.md +146 -146
  229. package/skills/backend/graphql-architect/references/federation.md +418 -418
  230. package/skills/backend/graphql-architect/references/migration-from-rest.md +1141 -1141
  231. package/skills/backend/graphql-architect/references/resolvers.md +425 -425
  232. package/skills/backend/graphql-architect/references/schema-design.md +393 -393
  233. package/skills/backend/graphql-architect/references/security.md +569 -569
  234. package/skills/backend/graphql-architect/references/subscriptions.md +510 -510
  235. package/skills/backend/legacy-modernizer/SKILL.md +137 -137
  236. package/skills/backend/legacy-modernizer/references/legacy-testing.md +381 -381
  237. package/skills/backend/legacy-modernizer/references/migration-strategies.md +423 -423
  238. package/skills/backend/legacy-modernizer/references/refactoring-patterns.md +395 -395
  239. package/skills/backend/legacy-modernizer/references/strangler-fig-pattern.md +281 -281
  240. package/skills/backend/legacy-modernizer/references/system-assessment.md +487 -487
  241. package/skills/backend/microservices-architect/SKILL.md +164 -164
  242. package/skills/backend/microservices-architect/references/communication.md +499 -499
  243. package/skills/backend/microservices-architect/references/data.md +721 -721
  244. package/skills/backend/microservices-architect/references/decomposition.md +344 -344
  245. package/skills/backend/microservices-architect/references/observability.md +805 -805
  246. package/skills/backend/microservices-architect/references/patterns.md +603 -603
  247. package/skills/database/database-optimizer/SKILL.md +147 -147
  248. package/skills/database/database-optimizer/references/index-strategies.md +331 -331
  249. package/skills/database/database-optimizer/references/monitoring-analysis.md +501 -501
  250. package/skills/database/database-optimizer/references/mysql-tuning.md +452 -452
  251. package/skills/database/database-optimizer/references/postgresql-tuning.md +413 -413
  252. package/skills/database/database-optimizer/references/query-optimization.md +251 -251
  253. package/skills/database/postgres-pro/SKILL.md +152 -152
  254. package/skills/database/postgres-pro/references/extensions.md +404 -404
  255. package/skills/database/postgres-pro/references/jsonb.md +321 -321
  256. package/skills/database/postgres-pro/references/maintenance.md +481 -481
  257. package/skills/database/postgres-pro/references/performance.md +265 -265
  258. package/skills/database/postgres-pro/references/replication.md +446 -446
  259. package/skills/database/sql-pro/SKILL.md +129 -129
  260. package/skills/database/sql-pro/references/database-design.md +402 -402
  261. package/skills/database/sql-pro/references/dialect-differences.md +419 -419
  262. package/skills/database/sql-pro/references/optimization.md +384 -384
  263. package/skills/database/sql-pro/references/query-patterns.md +285 -285
  264. package/skills/database/sql-pro/references/window-functions.md +328 -328
  265. package/skills/dotnet/csharp-developer/SKILL.md +125 -125
  266. package/skills/dotnet/csharp-developer/references/aspnet-core.md +394 -394
  267. package/skills/dotnet/csharp-developer/references/blazor.md +553 -553
  268. package/skills/dotnet/csharp-developer/references/entity-framework.md +409 -409
  269. package/skills/dotnet/csharp-developer/references/modern-csharp.md +248 -248
  270. package/skills/dotnet/csharp-developer/references/performance.md +498 -498
  271. package/skills/dotnet/dotnet-core-expert/SKILL.md +138 -138
  272. package/skills/dotnet/dotnet-core-expert/references/authentication.md +546 -546
  273. package/skills/dotnet/dotnet-core-expert/references/clean-architecture.md +455 -455
  274. package/skills/dotnet/dotnet-core-expert/references/cloud-native.md +548 -548
  275. package/skills/dotnet/dotnet-core-expert/references/entity-framework.md +440 -440
  276. package/skills/dotnet/dotnet-core-expert/references/minimal-apis.md +319 -319
  277. package/skills/frontend/angular-architect/SKILL.md +152 -152
  278. package/skills/frontend/angular-architect/references/components.md +297 -297
  279. package/skills/frontend/angular-architect/references/ngrx.md +401 -401
  280. package/skills/frontend/angular-architect/references/routing.md +361 -361
  281. package/skills/frontend/angular-architect/references/rxjs.md +319 -319
  282. package/skills/frontend/angular-architect/references/testing.md +405 -405
  283. package/skills/frontend/design-commands/design.md +91 -91
  284. package/skills/frontend/design-commands/handoff.md +97 -97
  285. package/skills/frontend/design-commands/prototype.md +120 -120
  286. package/skills/frontend/design-commands/spec.md +160 -160
  287. package/skills/frontend/design-commands/style.md +78 -78
  288. package/skills/frontend/flutter-expert/SKILL.md +138 -138
  289. package/skills/frontend/flutter-expert/references/bloc-state.md +259 -259
  290. package/skills/frontend/flutter-expert/references/gorouter-navigation.md +119 -119
  291. package/skills/frontend/flutter-expert/references/performance.md +99 -99
  292. package/skills/frontend/flutter-expert/references/project-structure.md +118 -118
  293. package/skills/frontend/flutter-expert/references/riverpod-state.md +130 -130
  294. package/skills/frontend/flutter-expert/references/widget-patterns.md +123 -123
  295. package/skills/frontend/nextjs-developer/SKILL.md +143 -143
  296. package/skills/frontend/nextjs-developer/references/app-router.md +311 -311
  297. package/skills/frontend/nextjs-developer/references/data-fetching.md +482 -482
  298. package/skills/frontend/nextjs-developer/references/deployment.md +545 -545
  299. package/skills/frontend/nextjs-developer/references/server-actions.md +462 -462
  300. package/skills/frontend/nextjs-developer/references/server-components.md +384 -384
  301. package/skills/frontend/react-expert/SKILL.md +149 -149
  302. package/skills/frontend/react-expert/references/hooks-patterns.md +162 -162
  303. package/skills/frontend/react-expert/references/migration-class-to-modern.md +1119 -1119
  304. package/skills/frontend/react-expert/references/performance.md +168 -168
  305. package/skills/frontend/react-expert/references/react-19-features.md +174 -174
  306. package/skills/frontend/react-expert/references/server-components.md +143 -143
  307. package/skills/frontend/react-expert/references/state-management.md +171 -171
  308. package/skills/frontend/react-expert/references/testing-react.md +174 -174
  309. package/skills/frontend/react-native-expert/SKILL.md +185 -185
  310. package/skills/frontend/react-native-expert/references/expo-router.md +187 -187
  311. package/skills/frontend/react-native-expert/references/list-optimization.md +204 -204
  312. package/skills/frontend/react-native-expert/references/platform-handling.md +188 -188
  313. package/skills/frontend/react-native-expert/references/project-structure.md +171 -171
  314. package/skills/frontend/react-native-expert/references/storage-hooks.md +173 -173
  315. package/skills/frontend/senior-frontend/SKILL.md +477 -477
  316. package/skills/frontend/senior-frontend/references/frontend_best_practices.md +806 -806
  317. package/skills/frontend/senior-frontend/references/nextjs_optimization_guide.md +724 -724
  318. package/skills/frontend/senior-frontend/references/react_patterns.md +746 -746
  319. package/skills/frontend/senior-frontend/scripts/bundle_analyzer.py +407 -407
  320. package/skills/frontend/senior-frontend/scripts/component_generator.py +329 -329
  321. package/skills/frontend/senior-frontend/scripts/frontend_scaffolder.py +1005 -1005
  322. package/skills/frontend/ui-ux-pro-max/SKILL.md +386 -386
  323. package/skills/frontend/ui-ux-pro-max/data/charts.csv +26 -26
  324. package/skills/frontend/ui-ux-pro-max/data/colors.csv +97 -97
  325. package/skills/frontend/ui-ux-pro-max/data/icons.csv +101 -101
  326. package/skills/frontend/ui-ux-pro-max/data/landing.csv +31 -31
  327. package/skills/frontend/ui-ux-pro-max/data/products.csv +96 -96
  328. package/skills/frontend/ui-ux-pro-max/data/react-performance.csv +45 -45
  329. package/skills/frontend/ui-ux-pro-max/data/stacks/astro.csv +54 -54
  330. package/skills/frontend/ui-ux-pro-max/data/stacks/flutter.csv +53 -53
  331. package/skills/frontend/ui-ux-pro-max/data/stacks/html-tailwind.csv +56 -56
  332. package/skills/frontend/ui-ux-pro-max/data/stacks/jetpack-compose.csv +53 -53
  333. package/skills/frontend/ui-ux-pro-max/data/stacks/nextjs.csv +53 -53
  334. package/skills/frontend/ui-ux-pro-max/data/stacks/nuxt-ui.csv +51 -51
  335. package/skills/frontend/ui-ux-pro-max/data/stacks/nuxtjs.csv +59 -59
  336. package/skills/frontend/ui-ux-pro-max/data/stacks/react-native.csv +52 -52
  337. package/skills/frontend/ui-ux-pro-max/data/stacks/react.csv +54 -54
  338. package/skills/frontend/ui-ux-pro-max/data/stacks/shadcn.csv +61 -61
  339. package/skills/frontend/ui-ux-pro-max/data/stacks/svelte.csv +54 -54
  340. package/skills/frontend/ui-ux-pro-max/data/stacks/swiftui.csv +51 -51
  341. package/skills/frontend/ui-ux-pro-max/data/stacks/vue.csv +50 -50
  342. package/skills/frontend/ui-ux-pro-max/data/styles.csv +68 -68
  343. package/skills/frontend/ui-ux-pro-max/data/typography.csv +57 -57
  344. package/skills/frontend/ui-ux-pro-max/data/ui-reasoning.csv +101 -101
  345. package/skills/frontend/ui-ux-pro-max/data/ux-guidelines.csv +99 -99
  346. package/skills/frontend/ui-ux-pro-max/data/web-interface.csv +31 -31
  347. package/skills/frontend/ui-ux-pro-max/scripts/core.py +253 -253
  348. package/skills/frontend/ui-ux-pro-max/scripts/design_system.py +1067 -1067
  349. package/skills/frontend/ui-ux-pro-max/scripts/search.py +114 -114
  350. package/skills/frontend/vue-expert/SKILL.md +98 -98
  351. package/skills/frontend/vue-expert/references/build-tooling.md +480 -480
  352. package/skills/frontend/vue-expert/references/components.md +448 -448
  353. package/skills/frontend/vue-expert/references/composition-api.md +299 -299
  354. package/skills/frontend/vue-expert/references/mobile-hybrid.md +636 -636
  355. package/skills/frontend/vue-expert/references/nuxt.md +669 -669
  356. package/skills/frontend/vue-expert/references/state-management.md +449 -449
  357. package/skills/frontend/vue-expert/references/typescript.md +584 -584
  358. package/skills/frontend/vue-expert-js/SKILL.md +167 -167
  359. package/skills/frontend/vue-expert-js/references/component-architecture.md +219 -219
  360. package/skills/frontend/vue-expert-js/references/composables-patterns.md +183 -183
  361. package/skills/frontend/vue-expert-js/references/jsdoc-typing.md +535 -535
  362. package/skills/frontend/vue-expert-js/references/state-management.md +249 -249
  363. package/skills/frontend/vue-expert-js/references/testing-patterns.md +237 -237
  364. package/skills/go-rust-cpp/cpp-pro/SKILL.md +115 -115
  365. package/skills/go-rust-cpp/cpp-pro/references/build-tooling.md +440 -440
  366. package/skills/go-rust-cpp/cpp-pro/references/concurrency.md +437 -437
  367. package/skills/go-rust-cpp/cpp-pro/references/memory-performance.md +397 -397
  368. package/skills/go-rust-cpp/cpp-pro/references/modern-cpp.md +304 -304
  369. package/skills/go-rust-cpp/cpp-pro/references/templates.md +357 -357
  370. package/skills/go-rust-cpp/golang-pro/SKILL.md +122 -122
  371. package/skills/go-rust-cpp/golang-pro/references/concurrency.md +329 -329
  372. package/skills/go-rust-cpp/golang-pro/references/generics.md +442 -442
  373. package/skills/go-rust-cpp/golang-pro/references/interfaces.md +432 -432
  374. package/skills/go-rust-cpp/golang-pro/references/project-structure.md +477 -477
  375. package/skills/go-rust-cpp/golang-pro/references/testing.md +451 -451
  376. package/skills/go-rust-cpp/rust-engineer/SKILL.md +167 -167
  377. package/skills/go-rust-cpp/rust-engineer/references/async.md +458 -458
  378. package/skills/go-rust-cpp/rust-engineer/references/error-handling.md +334 -334
  379. package/skills/go-rust-cpp/rust-engineer/references/ownership.md +278 -278
  380. package/skills/go-rust-cpp/rust-engineer/references/testing.md +470 -470
  381. package/skills/go-rust-cpp/rust-engineer/references/traits.md +413 -413
  382. package/skills/infra/cli-developer/SKILL.md +113 -113
  383. package/skills/infra/cli-developer/references/design-patterns.md +221 -221
  384. package/skills/infra/cli-developer/references/go-cli.md +540 -540
  385. package/skills/infra/cli-developer/references/node-cli.md +383 -383
  386. package/skills/infra/cli-developer/references/python-cli.md +422 -422
  387. package/skills/infra/cli-developer/references/ux-patterns.md +448 -448
  388. package/skills/infra/cloud-architect/SKILL.md +216 -216
  389. package/skills/infra/cloud-architect/references/aws.md +394 -394
  390. package/skills/infra/cloud-architect/references/azure.md +562 -562
  391. package/skills/infra/cloud-architect/references/cost.md +582 -582
  392. package/skills/infra/cloud-architect/references/gcp.md +633 -633
  393. package/skills/infra/cloud-architect/references/multi-cloud.md +483 -483
  394. package/skills/infra/devops-engineer/SKILL.md +144 -144
  395. package/skills/infra/devops-engineer/references/deployment-strategies.md +241 -241
  396. package/skills/infra/devops-engineer/references/docker-patterns.md +113 -113
  397. package/skills/infra/devops-engineer/references/github-actions.md +139 -139
  398. package/skills/infra/devops-engineer/references/incident-response.md +331 -331
  399. package/skills/infra/devops-engineer/references/kubernetes.md +154 -154
  400. package/skills/infra/devops-engineer/references/platform-engineering.md +417 -417
  401. package/skills/infra/devops-engineer/references/release-automation.md +527 -527
  402. package/skills/infra/devops-engineer/references/terraform-iac.md +141 -141
  403. package/skills/infra/kubernetes-specialist/SKILL.md +241 -241
  404. package/skills/infra/kubernetes-specialist/references/configuration.md +452 -452
  405. package/skills/infra/kubernetes-specialist/references/cost-optimization.md +458 -458
  406. package/skills/infra/kubernetes-specialist/references/custom-operators.md +563 -563
  407. package/skills/infra/kubernetes-specialist/references/gitops.md +530 -530
  408. package/skills/infra/kubernetes-specialist/references/helm-charts.md +912 -912
  409. package/skills/infra/kubernetes-specialist/references/multi-cluster.md +507 -507
  410. package/skills/infra/kubernetes-specialist/references/networking.md +447 -447
  411. package/skills/infra/kubernetes-specialist/references/service-mesh.md +459 -459
  412. package/skills/infra/kubernetes-specialist/references/storage.md +535 -535
  413. package/skills/infra/kubernetes-specialist/references/troubleshooting.md +414 -414
  414. package/skills/infra/kubernetes-specialist/references/workloads.md +377 -377
  415. package/skills/infra/mcp-developer/SKILL.md +143 -143
  416. package/skills/infra/mcp-developer/references/protocol.md +244 -244
  417. package/skills/infra/mcp-developer/references/python-sdk.md +367 -367
  418. package/skills/infra/mcp-developer/references/resources.md +554 -554
  419. package/skills/infra/mcp-developer/references/tools.md +480 -480
  420. package/skills/infra/mcp-developer/references/typescript-sdk.md +350 -350
  421. package/skills/infra/monitoring-expert/SKILL.md +176 -176
  422. package/skills/infra/monitoring-expert/references/alerting-rules.md +141 -141
  423. package/skills/infra/monitoring-expert/references/application-profiling.md +331 -331
  424. package/skills/infra/monitoring-expert/references/capacity-planning.md +344 -344
  425. package/skills/infra/monitoring-expert/references/dashboards.md +126 -126
  426. package/skills/infra/monitoring-expert/references/opentelemetry.md +123 -123
  427. package/skills/infra/monitoring-expert/references/performance-testing.md +269 -269
  428. package/skills/infra/monitoring-expert/references/prometheus-metrics.md +136 -136
  429. package/skills/infra/monitoring-expert/references/structured-logging.md +142 -142
  430. package/skills/infra/sre-engineer/SKILL.md +181 -181
  431. package/skills/infra/sre-engineer/references/automation-toil.md +492 -492
  432. package/skills/infra/sre-engineer/references/error-budget-policy.md +334 -334
  433. package/skills/infra/sre-engineer/references/incident-chaos.md +576 -576
  434. package/skills/infra/sre-engineer/references/monitoring-alerting.md +424 -424
  435. package/skills/infra/sre-engineer/references/slo-sli-management.md +238 -238
  436. package/skills/infra/terraform-engineer/SKILL.md +143 -143
  437. package/skills/infra/terraform-engineer/references/best-practices.md +583 -583
  438. package/skills/infra/terraform-engineer/references/module-patterns.md +297 -297
  439. package/skills/infra/terraform-engineer/references/providers.md +452 -452
  440. package/skills/infra/terraform-engineer/references/state-management.md +371 -371
  441. package/skills/infra/terraform-engineer/references/testing.md +486 -486
  442. package/skills/infra/websocket-engineer/SKILL.md +168 -168
  443. package/skills/infra/websocket-engineer/references/alternatives.md +391 -391
  444. package/skills/infra/websocket-engineer/references/patterns.md +400 -400
  445. package/skills/infra/websocket-engineer/references/protocol.md +195 -195
  446. package/skills/infra/websocket-engineer/references/scaling.md +333 -333
  447. package/skills/infra/websocket-engineer/references/security.md +474 -474
  448. package/skills/java/java-architect/SKILL.md +132 -132
  449. package/skills/java/java-architect/references/jpa-optimization.md +393 -393
  450. package/skills/java/java-architect/references/reactive-webflux.md +356 -356
  451. package/skills/java/java-architect/references/spring-boot-setup.md +269 -269
  452. package/skills/java/java-architect/references/spring-security.md +445 -445
  453. package/skills/java/java-architect/references/testing-patterns.md +500 -500
  454. package/skills/java/kotlin-specialist/SKILL.md +147 -147
  455. package/skills/java/kotlin-specialist/references/android-compose.md +419 -419
  456. package/skills/java/kotlin-specialist/references/coroutines-flow.md +276 -276
  457. package/skills/java/kotlin-specialist/references/dsl-idioms.md +421 -421
  458. package/skills/java/kotlin-specialist/references/ktor-server.md +426 -426
  459. package/skills/java/kotlin-specialist/references/multiplatform-kmp.md +380 -380
  460. package/skills/java/spring-boot-engineer/SKILL.md +196 -195
  461. package/skills/java/spring-boot-engineer/references/cloud.md +498 -498
  462. package/skills/java/spring-boot-engineer/references/data.md +381 -381
  463. package/skills/java/spring-boot-engineer/references/mybatis-plus.md +592 -0
  464. package/skills/java/spring-boot-engineer/references/security.md +459 -459
  465. package/skills/java/spring-boot-engineer/references/testing.md +545 -545
  466. package/skills/java/spring-boot-engineer/references/web.md +295 -295
  467. package/skills/java/spring-boot-engineer_zn/SKILL.md +129 -0
  468. package/skills/java/spring-boot-engineer_zn/references/architecture.md +23 -0
  469. package/skills/java/spring-boot-engineer_zn/references/concurrency.md +9 -0
  470. package/skills/java/spring-boot-engineer_zn/references/exception-logging.md +31 -0
  471. package/skills/java/spring-boot-engineer_zn/references/persistence.md +13 -0
  472. package/skills/java/spring-boot-engineer_zn/references/pojo-lombok.md +48 -0
  473. package/skills/java/spring-boot-engineer_zn/references/security.md +9 -0
  474. package/skills/java/spring-boot-engineer_zn/references/testing.md +7 -0
  475. package/skills/java/spring-boot-engineer_zn/references/validation.md +80 -0
  476. package/skills/javascript/javascript-pro/SKILL.md +132 -132
  477. package/skills/javascript/javascript-pro/references/async-patterns.md +334 -334
  478. package/skills/javascript/javascript-pro/references/browser-apis.md +398 -398
  479. package/skills/javascript/javascript-pro/references/modern-syntax.md +272 -272
  480. package/skills/javascript/javascript-pro/references/modules.md +357 -357
  481. package/skills/javascript/javascript-pro/references/node-essentials.md +471 -471
  482. package/skills/javascript/nestjs-expert/SKILL.md +206 -206
  483. package/skills/javascript/nestjs-expert/references/authentication.md +166 -166
  484. package/skills/javascript/nestjs-expert/references/controllers-routing.md +111 -111
  485. package/skills/javascript/nestjs-expert/references/dtos-validation.md +153 -153
  486. package/skills/javascript/nestjs-expert/references/migration-from-express.md +1237 -1237
  487. package/skills/javascript/nestjs-expert/references/services-di.md +140 -140
  488. package/skills/javascript/nestjs-expert/references/testing-patterns.md +186 -186
  489. package/skills/javascript/typescript-pro/SKILL.md +145 -145
  490. package/skills/javascript/typescript-pro/references/advanced-types.md +259 -259
  491. package/skills/javascript/typescript-pro/references/configuration.md +445 -445
  492. package/skills/javascript/typescript-pro/references/patterns.md +484 -484
  493. package/skills/javascript/typescript-pro/references/type-guards.md +352 -352
  494. package/skills/javascript/typescript-pro/references/utility-types.md +329 -329
  495. package/skills/php/laravel-specialist/SKILL.md +262 -262
  496. package/skills/php/laravel-specialist/references/eloquent.md +351 -351
  497. package/skills/php/laravel-specialist/references/livewire.md +512 -512
  498. package/skills/php/laravel-specialist/references/queues.md +423 -423
  499. package/skills/php/laravel-specialist/references/routing.md +362 -362
  500. package/skills/php/laravel-specialist/references/testing.md +522 -522
  501. package/skills/php/php-pro/SKILL.md +206 -206
  502. package/skills/php/php-pro/references/async-patterns.md +412 -412
  503. package/skills/php/php-pro/references/laravel-patterns.md +377 -377
  504. package/skills/php/php-pro/references/modern-php-features.md +323 -323
  505. package/skills/php/php-pro/references/symfony-patterns.md +466 -466
  506. package/skills/php/php-pro/references/testing-quality.md +466 -466
  507. package/skills/product/competitive-analysis/SKILL.md +257 -257
  508. package/skills/product/meeting-notes/SKILL.md +266 -266
  509. package/skills/product/prd-template/SKILL.md +150 -150
  510. package/skills/product/stakeholder-update/SKILL.md +225 -225
  511. package/skills/product/user-research-synthesis/SKILL.md +235 -235
  512. package/skills/python/django-expert/SKILL.md +162 -162
  513. package/skills/python/django-expert/references/authentication.md +145 -145
  514. package/skills/python/django-expert/references/drf-serializers.md +148 -148
  515. package/skills/python/django-expert/references/models-orm.md +151 -151
  516. package/skills/python/django-expert/references/testing-django.md +204 -204
  517. package/skills/python/django-expert/references/viewsets-views.md +153 -153
  518. package/skills/python/fastapi-expert/SKILL.md +185 -185
  519. package/skills/python/fastapi-expert/references/async-sqlalchemy.md +146 -146
  520. package/skills/python/fastapi-expert/references/authentication.md +159 -159
  521. package/skills/python/fastapi-expert/references/endpoints-routing.md +142 -142
  522. package/skills/python/fastapi-expert/references/migration-from-django.md +996 -996
  523. package/skills/python/fastapi-expert/references/pydantic-v2.md +135 -135
  524. package/skills/python/fastapi-expert/references/testing-async.md +159 -159
  525. package/skills/python/pandas-pro/SKILL.md +178 -178
  526. package/skills/python/pandas-pro/references/aggregation-groupby.md +545 -545
  527. package/skills/python/pandas-pro/references/data-cleaning.md +500 -500
  528. package/skills/python/pandas-pro/references/dataframe-operations.md +420 -420
  529. package/skills/python/pandas-pro/references/merging-joining.md +596 -596
  530. package/skills/python/pandas-pro/references/performance-optimization.md +597 -597
  531. package/skills/python/python-pro/SKILL.md +177 -177
  532. package/skills/python/python-pro/references/async-patterns.md +356 -356
  533. package/skills/python/python-pro/references/packaging.md +460 -460
  534. package/skills/python/python-pro/references/standard-library.md +378 -378
  535. package/skills/python/python-pro/references/testing.md +404 -404
  536. package/skills/python/python-pro/references/type-system.md +290 -290
  537. package/skills/quality/chaos-engineer/SKILL.md +182 -182
  538. package/skills/quality/chaos-engineer/references/chaos-tools.md +511 -511
  539. package/skills/quality/chaos-engineer/references/experiment-design.md +229 -229
  540. package/skills/quality/chaos-engineer/references/game-days.md +434 -434
  541. package/skills/quality/chaos-engineer/references/infrastructure-chaos.md +348 -348
  542. package/skills/quality/chaos-engineer/references/kubernetes-chaos.md +432 -432
  543. package/skills/quality/code-reviewer/SKILL.md +119 -119
  544. package/skills/quality/code-reviewer/references/common-issues.md +142 -142
  545. package/skills/quality/code-reviewer/references/feedback-examples.md +144 -144
  546. package/skills/quality/code-reviewer/references/receiving-feedback.md +238 -238
  547. package/skills/quality/code-reviewer/references/report-template.md +109 -109
  548. package/skills/quality/code-reviewer/references/review-checklist.md +88 -88
  549. package/skills/quality/code-reviewer/references/spec-compliance-review.md +258 -258
  550. package/skills/quality/playwright-expert/SKILL.md +169 -169
  551. package/skills/quality/playwright-expert/references/api-mocking.md +140 -140
  552. package/skills/quality/playwright-expert/references/configuration.md +155 -155
  553. package/skills/quality/playwright-expert/references/debugging-flaky.md +150 -150
  554. package/skills/quality/playwright-expert/references/page-object-model.md +152 -152
  555. package/skills/quality/playwright-expert/references/selectors-locators.md +119 -119
  556. package/skills/quality/secure-code-guardian/SKILL.md +191 -191
  557. package/skills/quality/secure-code-guardian/references/authentication.md +136 -136
  558. package/skills/quality/secure-code-guardian/references/input-validation.md +146 -146
  559. package/skills/quality/secure-code-guardian/references/owasp-prevention.md +135 -135
  560. package/skills/quality/secure-code-guardian/references/security-headers.md +133 -133
  561. package/skills/quality/secure-code-guardian/references/xss-csrf.md +157 -157
  562. package/skills/quality/security-reviewer/SKILL.md +103 -103
  563. package/skills/quality/security-reviewer/references/infrastructure-security.md +268 -268
  564. package/skills/quality/security-reviewer/references/penetration-testing.md +268 -268
  565. package/skills/quality/security-reviewer/references/report-template.md +170 -170
  566. package/skills/quality/security-reviewer/references/sast-tools.md +117 -117
  567. package/skills/quality/security-reviewer/references/secret-scanning.md +125 -125
  568. package/skills/quality/security-reviewer/references/vulnerability-patterns.md +152 -152
  569. package/skills/quality/senior-qa/README.md +196 -196
  570. package/skills/quality/senior-qa/SKILL.md +399 -399
  571. package/skills/quality/senior-qa/references/qa_best_practices.md +964 -964
  572. package/skills/quality/senior-qa/references/test_automation_patterns.md +1009 -1009
  573. package/skills/quality/senior-qa/references/testing_strategies.md +649 -649
  574. package/skills/quality/senior-qa/scripts/coverage_analyzer.py +836 -836
  575. package/skills/quality/senior-qa/scripts/e2e_test_scaffolder.py +820 -820
  576. package/skills/quality/senior-qa/scripts/test_suite_generator.py +605 -605
  577. package/skills/quality/tdd-guide/HOW_TO_USE.md +313 -313
  578. package/skills/quality/tdd-guide/README.md +680 -680
  579. package/skills/quality/tdd-guide/SKILL.md +122 -122
  580. package/skills/quality/tdd-guide/assets/expected_output.json +77 -77
  581. package/skills/quality/tdd-guide/assets/sample_input_python.json +39 -39
  582. package/skills/quality/tdd-guide/assets/sample_input_typescript.json +36 -36
  583. package/skills/quality/tdd-guide/references/ci-integration.md +195 -195
  584. package/skills/quality/tdd-guide/references/framework-guide.md +206 -206
  585. package/skills/quality/tdd-guide/references/tdd-best-practices.md +128 -128
  586. package/skills/quality/tdd-guide/scripts/coverage_analyzer.py +434 -434
  587. package/skills/quality/tdd-guide/scripts/fixture_generator.py +440 -440
  588. package/skills/quality/tdd-guide/scripts/format_detector.py +384 -384
  589. package/skills/quality/tdd-guide/scripts/framework_adapter.py +428 -428
  590. package/skills/quality/tdd-guide/scripts/metrics_calculator.py +456 -456
  591. package/skills/quality/tdd-guide/scripts/output_formatter.py +354 -354
  592. package/skills/quality/tdd-guide/scripts/tdd_workflow.py +474 -474
  593. package/skills/quality/tdd-guide/scripts/test_generator.py +438 -438
  594. package/skills/quality/test-master/SKILL.md +94 -94
  595. package/skills/quality/test-master/references/automation-frameworks.md +294 -294
  596. package/skills/quality/test-master/references/e2e-testing.md +128 -128
  597. package/skills/quality/test-master/references/integration-testing.md +120 -120
  598. package/skills/quality/test-master/references/performance-testing.md +118 -118
  599. package/skills/quality/test-master/references/qa-methodology.md +247 -247
  600. package/skills/quality/test-master/references/security-testing.md +127 -127
  601. package/skills/quality/test-master/references/tdd-iron-laws.md +174 -174
  602. package/skills/quality/test-master/references/test-reports.md +104 -104
  603. package/skills/quality/test-master/references/testing-anti-patterns.md +231 -231
  604. package/skills/quality/test-master/references/unit-testing.md +113 -113
  605. package/skills/ruby/rails-expert/SKILL.md +154 -154
  606. package/skills/ruby/rails-expert/references/active-record.md +244 -244
  607. package/skills/ruby/rails-expert/references/api-development.md +401 -401
  608. package/skills/ruby/rails-expert/references/background-jobs.md +272 -272
  609. package/skills/ruby/rails-expert/references/hotwire-turbo.md +228 -228
  610. package/skills/ruby/rails-expert/references/rspec-testing.md +367 -367
  611. package/skills/swift/swift-expert/SKILL.md +163 -163
  612. package/skills/swift/swift-expert/references/async-concurrency.md +360 -360
  613. package/skills/swift/swift-expert/references/memory-performance.md +377 -377
  614. package/skills/swift/swift-expert/references/protocol-oriented.md +354 -354
  615. package/skills/swift/swift-expert/references/swiftui-patterns.md +291 -291
  616. package/skills/swift/swift-expert/references/testing-patterns.md +399 -399
  617. package/skills/workflow/brainstorming/SKILL.md +164 -164
  618. package/skills/workflow/brainstorming/scripts/frame-template.html +214 -214
  619. package/skills/workflow/brainstorming/scripts/helper.js +88 -88
  620. package/skills/workflow/brainstorming/scripts/server.cjs +354 -354
  621. package/skills/workflow/brainstorming/scripts/start-server.sh +148 -148
  622. package/skills/workflow/brainstorming/scripts/stop-server.sh +56 -56
  623. package/skills/workflow/brainstorming/spec-document-reviewer-prompt.md +49 -49
  624. package/skills/workflow/brainstorming/visual-companion.md +287 -287
  625. package/skills/workflow/documentation/SKILL.md +45 -45
  626. package/skills/workflow/entropy-management/SKILL.md +115 -115
  627. package/skills/workflow/executing-plans/SKILL.md +70 -70
  628. package/skills/workflow/finishing-a-development-branch/SKILL.md +200 -200
  629. package/skills/workflow/receiving-code-review/SKILL.md +213 -213
  630. package/skills/workflow/requesting-code-review/SKILL.md +105 -105
  631. package/skills/workflow/requesting-code-review/code-reviewer.md +146 -146
  632. package/skills/workflow/requirement-engineering/SKILL.md +111 -111
  633. package/skills/workflow/systematic-debugging/CREATION-LOG.md +119 -119
  634. package/skills/workflow/systematic-debugging/SKILL.md +296 -296
  635. package/skills/workflow/systematic-debugging/condition-based-waiting-example.ts +158 -158
  636. package/skills/workflow/systematic-debugging/condition-based-waiting.md +115 -115
  637. package/skills/workflow/systematic-debugging/defense-in-depth.md +122 -122
  638. package/skills/workflow/systematic-debugging/find-polluter.sh +63 -63
  639. package/skills/workflow/systematic-debugging/root-cause-tracing.md +169 -169
  640. package/skills/workflow/systematic-debugging/test-academic.md +14 -14
  641. package/skills/workflow/systematic-debugging/test-pressure-1.md +58 -58
  642. package/skills/workflow/systematic-debugging/test-pressure-2.md +68 -68
  643. package/skills/workflow/systematic-debugging/test-pressure-3.md +69 -69
  644. package/skills/workflow/using-git-worktrees/SKILL.md +218 -218
  645. package/skills/workflow/verification-before-completion/SKILL.md +139 -139
  646. package/skills/workflow/writing-plans/SKILL.md +151 -151
  647. package/skills/workflow/writing-plans/plan-document-reviewer-prompt.md +49 -49
  648. package/skills/workflow/writing-skills/SKILL.md +655 -655
  649. package/skills/workflow/writing-skills/anthropic-best-practices.md +1150 -1150
  650. package/skills/workflow/writing-skills/examples/CLAUDE_MD_TESTING.md +189 -189
  651. package/skills/workflow/writing-skills/persuasion-principles.md +187 -187
  652. package/skills/workflow/writing-skills/render-graphs.js +168 -168
  653. package/skills/workflow/writing-skills/testing-skills-with-subagents.md +384 -384
@@ -1,786 +1,786 @@
1
- # Streaming Patterns
2
-
3
- ---
4
-
5
- ## Structured Streaming Overview
6
-
7
- ### When to Use Structured Streaming
8
-
9
- **Use when:**
10
- - Processing continuous data streams (Kafka, files, sockets)
11
- - Need exactly-once processing guarantees
12
- - Real-time analytics and dashboards
13
- - Event-driven architectures
14
- - Incremental ETL from streaming sources
15
-
16
- **Consider alternatives when:**
17
- - Batch processing is sufficient (lower complexity)
18
- - Sub-second latency required (consider Flink)
19
- - Very simple event processing (Kafka Streams may suffice)
20
-
21
- ---
22
-
23
- ## Reading from Streaming Sources
24
-
25
- ### Kafka Source
26
-
27
- ```python
28
- # Read from Kafka
29
- df = spark.readStream \
30
- .format("kafka") \
31
- .option("kafka.bootstrap.servers", "broker1:9092,broker2:9092") \
32
- .option("subscribe", "topic1,topic2") \
33
- .option("startingOffsets", "latest") \
34
- .option("maxOffsetsPerTrigger", 100000) \
35
- .option("kafka.security.protocol", "SASL_SSL") \
36
- .option("kafka.sasl.mechanism", "PLAIN") \
37
- .load()
38
-
39
- # Kafka provides key, value as bytes
40
- # Parse JSON value
41
- from pyspark.sql import functions as F
42
- from pyspark.sql.types import StructType, StructField, StringType, TimestampType, DoubleType
43
-
44
- schema = StructType([
45
- StructField("event_id", StringType()),
46
- StructField("user_id", StringType()),
47
- StructField("event_time", TimestampType()),
48
- StructField("amount", DoubleType())
49
- ])
50
-
51
- parsed_df = df.select(
52
- F.col("key").cast("string").alias("kafka_key"),
53
- F.from_json(F.col("value").cast("string"), schema).alias("data"),
54
- F.col("timestamp").alias("kafka_timestamp"),
55
- F.col("partition"),
56
- F.col("offset")
57
- ).select("kafka_key", "data.*", "kafka_timestamp", "partition", "offset")
58
- ```
59
-
60
- ```scala
61
- // Scala Kafka source
62
- val df = spark.readStream
63
- .format("kafka")
64
- .option("kafka.bootstrap.servers", "broker1:9092,broker2:9092")
65
- .option("subscribe", "topic1")
66
- .option("startingOffsets", "latest")
67
- .load()
68
-
69
- val parsed = df.select(
70
- col("key").cast("string"),
71
- from_json(col("value").cast("string"), schema).as("data")
72
- ).select("key", "data.*")
73
- ```
74
-
75
- ### File Source (Auto-Discovery)
76
-
77
- ```python
78
- # Read new files as they arrive
79
- df = spark.readStream \
80
- .format("parquet") \
81
- .schema(my_schema) \
82
- .option("path", "s3://bucket/incoming/") \
83
- .option("maxFilesPerTrigger", 100) \
84
- .load()
85
-
86
- # For JSON files
87
- df = spark.readStream \
88
- .format("json") \
89
- .schema(my_schema) \
90
- .option("path", "s3://bucket/incoming/") \
91
- .load()
92
-
93
- # CSV with header
94
- df = spark.readStream \
95
- .format("csv") \
96
- .schema(my_schema) \
97
- .option("path", "s3://bucket/incoming/") \
98
- .option("header", "true") \
99
- .load()
100
- ```
101
-
102
- ### Rate Source (Testing)
103
-
104
- ```python
105
- # Generate test data at specified rate
106
- df = spark.readStream \
107
- .format("rate") \
108
- .option("rowsPerSecond", 1000) \
109
- .option("numPartitions", 10) \
110
- .load()
111
-
112
- # Columns: timestamp, value (incrementing long)
113
- ```
114
-
115
- ---
116
-
117
- ## Output Modes
118
-
119
- ### Append Mode (Default)
120
-
121
- ```python
122
- # Only new rows added since last trigger
123
- # Use when: No aggregations, or windowed aggregations with watermark
124
- query = df.writeStream \
125
- .outputMode("append") \
126
- .format("parquet") \
127
- .option("path", "s3://bucket/output/") \
128
- .option("checkpointLocation", "s3://bucket/checkpoints/") \
129
- .start()
130
- ```
131
-
132
- ### Update Mode
133
-
134
- ```python
135
- # Only rows that changed since last trigger
136
- # Use when: Aggregations, want incremental updates
137
- query = df.groupBy("user_id").count() \
138
- .writeStream \
139
- .outputMode("update") \
140
- .format("console") \
141
- .start()
142
- ```
143
-
144
- ### Complete Mode
145
-
146
- ```python
147
- # Entire result table every trigger
148
- # Use when: Need full aggregation result each time
149
- # Warning: Can be expensive for large state
150
- query = df.groupBy("user_id").count() \
151
- .writeStream \
152
- .outputMode("complete") \
153
- .format("console") \
154
- .start()
155
- ```
156
-
157
- ### Mode Selection Guide
158
-
159
- | Use Case | Output Mode | Notes |
160
- |----------|-------------|-------|
161
- | ETL to files | append | Default, efficient |
162
- | Windowed aggregations | append | With watermark |
163
- | Running counts/sums | update | Incremental |
164
- | Dashboards needing full state | complete | Expensive |
165
- | Deduplication | append | With dropDuplicates |
166
-
167
- ---
168
-
169
- ## Watermarks and Event Time
170
-
171
- ### Understanding Watermarks
172
-
173
- Watermarks define how late data can arrive before being dropped. They enable Spark to:
174
- - Clean up old state (bounded memory)
175
- - Emit results at appropriate times
176
- - Handle out-of-order events
177
-
178
- ### Setting Watermarks
179
-
180
- ```python
181
- from pyspark.sql import functions as F
182
-
183
- # Define watermark on event time column
184
- df_with_watermark = df \
185
- .withWatermark("event_time", "10 minutes")
186
-
187
- # Watermark threshold: max_event_time - 10 minutes
188
- # Events older than watermark are dropped
189
- # State older than watermark is cleaned up
190
- ```
191
-
192
- ### Watermark Guidelines
193
-
194
- | Scenario | Watermark Duration | Reasoning |
195
- |----------|-------------------|-----------|
196
- | Real-time analytics | 1-5 minutes | Low latency, tolerate minimal late data |
197
- | Standard ETL | 10-30 minutes | Balance latency and late data |
198
- | Late-arriving data common | 1-24 hours | Accommodate delayed events |
199
- | Best-effort real-time | 0 minutes | No late data tolerance |
200
-
201
- ### Example with Windowed Aggregation
202
-
203
- ```python
204
- from pyspark.sql import functions as F
205
- from pyspark.sql.window import Window
206
-
207
- # Streaming aggregation with watermark
208
- result = df \
209
- .withWatermark("event_time", "10 minutes") \
210
- .groupBy(
211
- F.window("event_time", "5 minutes", "1 minute"), # 5-min tumbling window, 1-min slide
212
- "user_id"
213
- ) \
214
- .agg(
215
- F.count("*").alias("event_count"),
216
- F.sum("amount").alias("total_amount")
217
- )
218
-
219
- # Output schema includes window struct: window.start, window.end
220
- query = result \
221
- .select(
222
- F.col("window.start").alias("window_start"),
223
- F.col("window.end").alias("window_end"),
224
- "user_id",
225
- "event_count",
226
- "total_amount"
227
- ) \
228
- .writeStream \
229
- .outputMode("append") \
230
- .format("parquet") \
231
- .option("path", "s3://bucket/windowed_output/") \
232
- .option("checkpointLocation", "s3://bucket/checkpoints/") \
233
- .start()
234
- ```
235
-
236
- ---
237
-
238
- ## Windowed Operations
239
-
240
- ### Tumbling Windows (Non-Overlapping)
241
-
242
- ```python
243
- from pyspark.sql import functions as F
244
-
245
- # 5-minute tumbling windows
246
- result = df \
247
- .withWatermark("event_time", "10 minutes") \
248
- .groupBy(
249
- F.window("event_time", "5 minutes"),
250
- "category"
251
- ) \
252
- .agg(F.sum("amount").alias("total"))
253
-
254
- # Windows: [00:00-00:05), [00:05-00:10), [00:10-00:15), ...
255
- ```
256
-
257
- ### Sliding Windows (Overlapping)
258
-
259
- ```python
260
- # 10-minute windows, sliding every 2 minutes
261
- result = df \
262
- .withWatermark("event_time", "10 minutes") \
263
- .groupBy(
264
- F.window("event_time", "10 minutes", "2 minutes"),
265
- "category"
266
- ) \
267
- .agg(F.sum("amount").alias("total"))
268
-
269
- # Windows: [00:00-00:10), [00:02-00:12), [00:04-00:14), ...
270
- ```
271
-
272
- ### Session Windows (Gap-Based)
273
-
274
- ```python
275
- # Session windows with 5-minute gap threshold
276
- result = df \
277
- .withWatermark("event_time", "10 minutes") \
278
- .groupBy(
279
- F.session_window("event_time", "5 minutes"), # Spark 3.2+
280
- "user_id"
281
- ) \
282
- .agg(
283
- F.count("*").alias("events_in_session"),
284
- F.first("event_time").alias("session_start"),
285
- F.last("event_time").alias("session_end")
286
- )
287
- ```
288
-
289
- ---
290
-
291
- ## Stateful Operations
292
-
293
- ### Aggregations (Built-in State)
294
-
295
- ```python
296
- # Running count by key
297
- running_counts = df \
298
- .withWatermark("event_time", "1 hour") \
299
- .groupBy("user_id") \
300
- .agg(F.count("*").alias("total_events"))
301
-
302
- # State stored per user_id
303
- # Cleaned up based on watermark
304
- ```
305
-
306
- ### Deduplication
307
-
308
- ```python
309
- # Drop duplicates within watermark window
310
- deduped = df \
311
- .withWatermark("event_time", "10 minutes") \
312
- .dropDuplicates(["event_id"]) # Keep first occurrence
313
-
314
- # Can also dedupe by multiple columns
315
- deduped = df \
316
- .withWatermark("event_time", "10 minutes") \
317
- .dropDuplicates(["user_id", "event_type", "event_time"])
318
- ```
319
-
320
- ### Custom Stateful Processing (flatMapGroupsWithState)
321
-
322
- ```python
323
- # PySpark - Custom state using applyInPandasWithState (Spark 3.4+)
324
- from pyspark.sql.streaming.state import GroupState, GroupStateTimeout
325
-
326
- def update_session_state(
327
- key: tuple,
328
- pdf_iter: Iterator[pd.DataFrame],
329
- state: GroupState
330
- ) -> Iterator[pd.DataFrame]:
331
- # Get or initialize state
332
- if state.exists:
333
- session_data = state.get
334
- else:
335
- session_data = {"count": 0, "total": 0.0}
336
-
337
- # Process input data
338
- for pdf in pdf_iter:
339
- session_data["count"] += len(pdf)
340
- session_data["total"] += pdf["amount"].sum()
341
-
342
- # Update state
343
- state.update(session_data)
344
-
345
- # Optionally set timeout
346
- state.setTimeoutDuration(10 * 60 * 1000) # 10 minutes
347
-
348
- # Yield output
349
- yield pd.DataFrame([{
350
- "user_id": key[0],
351
- "event_count": session_data["count"],
352
- "total_amount": session_data["total"]
353
- }])
354
-
355
- # Apply stateful function
356
- result = df \
357
- .withWatermark("event_time", "10 minutes") \
358
- .groupBy("user_id") \
359
- .applyInPandasWithState(
360
- update_session_state,
361
- outputStructType=output_schema,
362
- stateStructType=state_schema,
363
- outputMode="update",
364
- timeoutConf=GroupStateTimeout.ProcessingTimeTimeout
365
- )
366
- ```
367
-
368
- ```scala
369
- // Scala flatMapGroupsWithState
370
- import org.apache.spark.sql.streaming.{GroupState, GroupStateTimeout}
371
-
372
- case class UserState(count: Long, totalAmount: Double)
373
- case class UserOutput(userId: String, count: Long, totalAmount: Double)
374
-
375
- def updateState(
376
- userId: String,
377
- events: Iterator[Event],
378
- state: GroupState[UserState]
379
- ): Iterator[UserOutput] = {
380
-
381
- val currentState = state.getOption.getOrElse(UserState(0, 0.0))
382
-
383
- var newCount = currentState.count
384
- var newTotal = currentState.totalAmount
385
-
386
- events.foreach { event =>
387
- newCount += 1
388
- newTotal += event.amount
389
- }
390
-
391
- val newState = UserState(newCount, newTotal)
392
- state.update(newState)
393
- state.setTimeoutDuration("10 minutes")
394
-
395
- Iterator(UserOutput(userId, newCount, newTotal))
396
- }
397
-
398
- val result = df
399
- .withWatermark("event_time", "10 minutes")
400
- .as[Event]
401
- .groupByKey(_.userId)
402
- .flatMapGroupsWithState(
403
- OutputMode.Update,
404
- GroupStateTimeout.ProcessingTimeTimeout
405
- )(updateState)
406
- ```
407
-
408
- ---
409
-
410
- ## Streaming Joins
411
-
412
- ### Stream-Static Join
413
-
414
- ```python
415
- # Join streaming data with static lookup table
416
- static_df = spark.read.parquet("s3://bucket/lookup/")
417
-
418
- # Streaming df joined with static - no watermark needed
419
- result = streaming_df.join(static_df, "join_key", "left")
420
-
421
- # Static table can be periodically refreshed
422
- # Use broadcast for small static tables
423
- from pyspark.sql.functions import broadcast
424
- result = streaming_df.join(broadcast(static_df), "join_key")
425
- ```
426
-
427
- ### Stream-Stream Join
428
-
429
- ```python
430
- # Join two streams - requires watermarks on both
431
- from pyspark.sql import functions as F
432
-
433
- stream1 = spark.readStream.format("kafka")...
434
- stream2 = spark.readStream.format("kafka")...
435
-
436
- # Both streams need watermarks
437
- stream1_wm = stream1.withWatermark("event_time", "10 minutes")
438
- stream2_wm = stream2.withWatermark("event_time", "10 minutes")
439
-
440
- # Inner join with time constraint
441
- result = stream1_wm.join(
442
- stream2_wm,
443
- F.expr("""
444
- stream1.user_id = stream2.user_id AND
445
- stream1.event_time >= stream2.event_time AND
446
- stream1.event_time <= stream2.event_time + INTERVAL 5 MINUTES
447
- """),
448
- "inner"
449
- )
450
-
451
- # Left outer join (Spark 2.3+)
452
- result = stream1_wm.join(
453
- stream2_wm,
454
- F.expr("""
455
- stream1.user_id = stream2.user_id AND
456
- stream1.event_time >= stream2.event_time - INTERVAL 5 MINUTES AND
457
- stream1.event_time <= stream2.event_time + INTERVAL 5 MINUTES
458
- """),
459
- "leftOuter"
460
- )
461
- ```
462
-
463
- ### Join Type Support
464
-
465
- | Join Type | Stream-Static | Stream-Stream |
466
- |-----------|---------------|---------------|
467
- | Inner | Yes | Yes |
468
- | Left Outer | Yes | Yes (Spark 2.3+) |
469
- | Right Outer | Yes | Yes (Spark 2.3+) |
470
- | Full Outer | Yes | Yes (Spark 2.4+) |
471
- | Left Semi | Yes | Not supported |
472
- | Left Anti | Yes | Not supported |
473
-
474
- ---
475
-
476
- ## Sinks
477
-
478
- ### Kafka Sink
479
-
480
- ```python
481
- # Write to Kafka
482
- query = df \
483
- .select(
484
- F.col("user_id").alias("key"),
485
- F.to_json(F.struct("*")).alias("value")
486
- ) \
487
- .writeStream \
488
- .format("kafka") \
489
- .option("kafka.bootstrap.servers", "broker1:9092") \
490
- .option("topic", "output_topic") \
491
- .option("checkpointLocation", "s3://bucket/checkpoints/") \
492
- .start()
493
- ```
494
-
495
- ### File Sink (Parquet, JSON, CSV)
496
-
497
- ```python
498
- # Parquet sink with partitioning
499
- query = df.writeStream \
500
- .format("parquet") \
501
- .option("path", "s3://bucket/output/") \
502
- .option("checkpointLocation", "s3://bucket/checkpoints/") \
503
- .partitionBy("date", "hour") \
504
- .trigger(processingTime="1 minute") \
505
- .start()
506
-
507
- # JSON sink
508
- query = df.writeStream \
509
- .format("json") \
510
- .option("path", "s3://bucket/output/") \
511
- .option("checkpointLocation", "s3://bucket/checkpoints/") \
512
- .start()
513
- ```
514
-
515
- ### Delta Lake Sink
516
-
517
- ```python
518
- # Delta Lake (ACID transactions, schema evolution)
519
- query = df.writeStream \
520
- .format("delta") \
521
- .outputMode("append") \
522
- .option("path", "s3://bucket/delta_table/") \
523
- .option("checkpointLocation", "s3://bucket/checkpoints/") \
524
- .option("mergeSchema", "true") \
525
- .start()
526
-
527
- # Upsert with foreachBatch
528
- def upsert_to_delta(batch_df, batch_id):
529
- delta_table = DeltaTable.forPath(spark, "s3://bucket/delta_table/")
530
- delta_table.alias("target").merge(
531
- batch_df.alias("source"),
532
- "target.id = source.id"
533
- ).whenMatchedUpdateAll() \
534
- .whenNotMatchedInsertAll() \
535
- .execute()
536
-
537
- query = df.writeStream \
538
- .foreachBatch(upsert_to_delta) \
539
- .option("checkpointLocation", "s3://bucket/checkpoints/") \
540
- .start()
541
- ```
542
-
543
- ### Custom Sink (foreachBatch)
544
-
545
- ```python
546
- def write_to_database(batch_df, batch_id):
547
- """Write each micro-batch to external database."""
548
- batch_df.write \
549
- .format("jdbc") \
550
- .option("url", "jdbc:postgresql://host:5432/db") \
551
- .option("dbtable", "output_table") \
552
- .option("user", "user") \
553
- .option("password", "password") \
554
- .mode("append") \
555
- .save()
556
-
557
- query = df.writeStream \
558
- .foreachBatch(write_to_database) \
559
- .option("checkpointLocation", "s3://bucket/checkpoints/") \
560
- .trigger(processingTime="30 seconds") \
561
- .start()
562
- ```
563
-
564
- ### foreach (Row-by-Row)
565
-
566
- ```python
567
- # For custom processing of each row
568
- class ForeachWriter:
569
- def open(self, partition_id, epoch_id):
570
- # Initialize connection
571
- self.connection = create_connection()
572
- return True
573
-
574
- def process(self, row):
575
- # Process each row
576
- self.connection.insert(row.asDict())
577
-
578
- def close(self, error):
579
- # Clean up
580
- self.connection.close()
581
-
582
- query = df.writeStream \
583
- .foreach(ForeachWriter()) \
584
- .start()
585
- ```
586
-
587
- ---
588
-
589
- ## Triggers
590
-
591
- ### Available Trigger Types
592
-
593
- ```python
594
- # Process as fast as possible (default)
595
- query = df.writeStream.trigger(processingTime="0 seconds").start()
596
-
597
- # Fixed interval
598
- query = df.writeStream.trigger(processingTime="1 minute").start()
599
-
600
- # Once - process all available data, then stop
601
- query = df.writeStream.trigger(once=True).start()
602
-
603
- # Available now - process all available data (Spark 3.3+)
604
- query = df.writeStream.trigger(availableNow=True).start()
605
-
606
- # Continuous processing (experimental, low latency)
607
- query = df.writeStream.trigger(continuous="1 second").start()
608
- ```
609
-
610
- ### Trigger Selection Guide
611
-
612
- | Trigger | Use Case |
613
- |---------|----------|
614
- | processingTime="0 seconds" | Maximum throughput |
615
- | processingTime="N seconds" | Controlled resource usage |
616
- | once=True | Batch-style processing |
617
- | availableNow=True | Catch-up processing |
618
- | continuous="N ms" | Ultra-low latency (experimental) |
619
-
620
- ---
621
-
622
- ## Monitoring and Management
623
-
624
- ### Query Management
625
-
626
- ```python
627
- # Start query and get handle
628
- query = df.writeStream.format("console").start()
629
-
630
- # Query properties
631
- print(f"Query ID: {query.id}")
632
- print(f"Run ID: {query.runId}")
633
- print(f"Name: {query.name}")
634
- print(f"Is Active: {query.isActive}")
635
- print(f"Status: {query.status}")
636
- print(f"Last Progress: {query.lastProgress}")
637
- print(f"Recent Progress: {query.recentProgress}")
638
-
639
- # Wait for termination
640
- query.awaitTermination()
641
- query.awaitTermination(timeout=60) # With timeout
642
-
643
- # Stop query
644
- query.stop()
645
-
646
- # Get exception if failed
647
- exception = query.exception()
648
- ```
649
-
650
- ### Progress Monitoring
651
-
652
- ```python
653
- # Get latest progress
654
- progress = query.lastProgress
655
- if progress:
656
- print(f"Input rows/sec: {progress['inputRowsPerSecond']}")
657
- print(f"Processed rows/sec: {progress['processedRowsPerSecond']}")
658
- print(f"Batch ID: {progress['batchId']}")
659
- print(f"Duration: {progress['batchDuration']} ms")
660
- print(f"State rows: {progress['stateOperators']}")
661
-
662
- # Custom progress listener
663
- class ProgressListener:
664
- def onQueryProgress(self, event):
665
- print(f"Progress: {event.progress}")
666
-
667
- def onQueryTerminated(self, event):
668
- print(f"Terminated: {event.exception}")
669
-
670
- spark.streams.addListener(ProgressListener())
671
- ```
672
-
673
- ### Checkpointing
674
-
675
- ```python
676
- # Checkpoint location is required for fault tolerance
677
- query = df.writeStream \
678
- .format("parquet") \
679
- .option("path", "s3://bucket/output/") \
680
- .option("checkpointLocation", "s3://bucket/checkpoints/query_name/") \
681
- .start()
682
-
683
- # Checkpoint contains:
684
- # - Offsets (what data has been processed)
685
- # - State (for stateful operations)
686
- # - Commits (what batches completed)
687
-
688
- # Recovery: Query restarts from last checkpoint automatically
689
- # Clean start: Delete checkpoint directory (loses state!)
690
- ```
691
-
692
- ---
693
-
694
- ## Performance Patterns
695
-
696
- ### Optimizing Throughput
697
-
698
- ```python
699
- # 1. Increase Kafka partitions for parallelism
700
- # Consumer parallelism = Kafka partitions
701
-
702
- # 2. Tune maxOffsetsPerTrigger
703
- query = df.readStream \
704
- .format("kafka") \
705
- .option("maxOffsetsPerTrigger", 500000) \ # More data per batch
706
- .load()
707
-
708
- # 3. Optimize shuffle partitions
709
- spark.conf.set("spark.sql.shuffle.partitions", 100)
710
-
711
- # 4. Use appropriate trigger interval
712
- query = df.writeStream \
713
- .trigger(processingTime="30 seconds") \
714
- .start()
715
-
716
- # 5. Enable AQE for dynamic optimization
717
- spark.conf.set("spark.sql.adaptive.enabled", "true")
718
- ```
719
-
720
- ### Managing State Size
721
-
722
- ```python
723
- # 1. Always use watermarks for stateful operations
724
- df.withWatermark("event_time", "1 hour")
725
-
726
- # 2. Monitor state size in progress
727
- progress = query.lastProgress
728
- for operator in progress["stateOperators"]:
729
- print(f"State rows: {operator['numRowsTotal']}")
730
- print(f"Memory used: {operator['memoryUsedBytes']}")
731
-
732
- # 3. Configure state store
733
- spark.conf.set("spark.sql.streaming.stateStore.providerClass",
734
- "org.apache.spark.sql.execution.streaming.state.RocksDBStateStoreProvider")
735
- # RocksDB handles larger state better than in-memory default
736
-
737
- # 4. Set state cleanup mode
738
- spark.conf.set("spark.sql.streaming.stateStore.stateSchemaCheck", "false")
739
- ```
740
-
741
- ---
742
-
743
- ## Common Anti-Patterns
744
-
745
- ```python
746
- # BAD: No watermark with aggregation
747
- df.groupBy("user_id").count() # Unbounded state growth!
748
-
749
- # GOOD: Always use watermark
750
- df.withWatermark("event_time", "1 hour").groupBy("user_id").count()
751
-
752
- # BAD: Complete mode with large state
753
- df.groupBy("user_id").count().writeStream.outputMode("complete") # Outputs entire state
754
-
755
- # GOOD: Update mode for incremental
756
- df.groupBy("user_id").count().writeStream.outputMode("update")
757
-
758
- # BAD: No checkpoint location
759
- query = df.writeStream.format("console").start() # No fault tolerance!
760
-
761
- # GOOD: Always specify checkpoint
762
- query = df.writeStream.format("console") \
763
- .option("checkpointLocation", "/checkpoints/query") \
764
- .start()
765
-
766
- # BAD: foreach for high-throughput
767
- df.writeStream.foreach(process_row).start() # Row-by-row overhead
768
-
769
- # GOOD: foreachBatch for batched processing
770
- df.writeStream.foreachBatch(process_batch).start() # Batch-level efficiency
771
- ```
772
-
773
- ---
774
-
775
- ## Best Practices Summary
776
-
777
- 1. **Always use watermarks** - Prevents unbounded state growth
778
- 2. **Choose appropriate output mode** - Append for ETL, Update for aggregations
779
- 3. **Set checkpoint locations** - Required for fault tolerance
780
- 4. **Use foreachBatch over foreach** - Better performance for custom sinks
781
- 5. **Monitor state size** - Watch for memory growth in progress metrics
782
- 6. **Tune trigger intervals** - Balance latency vs throughput
783
- 7. **Match Kafka partitions to parallelism** - Consumer tasks = Kafka partitions
784
- 8. **Use stream-static joins when possible** - Simpler than stream-stream
785
- 9. **Test with production data rates** - Performance varies with volume
786
- 10. **Enable structured streaming UI** - Detailed metrics in Spark UI
1
+ # Streaming Patterns
2
+
3
+ ---
4
+
5
+ ## Structured Streaming Overview
6
+
7
+ ### When to Use Structured Streaming
8
+
9
+ **Use when:**
10
+ - Processing continuous data streams (Kafka, files, sockets)
11
+ - Need exactly-once processing guarantees
12
+ - Real-time analytics and dashboards
13
+ - Event-driven architectures
14
+ - Incremental ETL from streaming sources
15
+
16
+ **Consider alternatives when:**
17
+ - Batch processing is sufficient (lower complexity)
18
+ - Sub-second latency required (consider Flink)
19
+ - Very simple event processing (Kafka Streams may suffice)
20
+
21
+ ---
22
+
23
+ ## Reading from Streaming Sources
24
+
25
+ ### Kafka Source
26
+
27
+ ```python
28
+ # Read from Kafka
29
+ df = spark.readStream \
30
+ .format("kafka") \
31
+ .option("kafka.bootstrap.servers", "broker1:9092,broker2:9092") \
32
+ .option("subscribe", "topic1,topic2") \
33
+ .option("startingOffsets", "latest") \
34
+ .option("maxOffsetsPerTrigger", 100000) \
35
+ .option("kafka.security.protocol", "SASL_SSL") \
36
+ .option("kafka.sasl.mechanism", "PLAIN") \
37
+ .load()
38
+
39
+ # Kafka provides key, value as bytes
40
+ # Parse JSON value
41
+ from pyspark.sql import functions as F
42
+ from pyspark.sql.types import StructType, StructField, StringType, TimestampType, DoubleType
43
+
44
+ schema = StructType([
45
+ StructField("event_id", StringType()),
46
+ StructField("user_id", StringType()),
47
+ StructField("event_time", TimestampType()),
48
+ StructField("amount", DoubleType())
49
+ ])
50
+
51
+ parsed_df = df.select(
52
+ F.col("key").cast("string").alias("kafka_key"),
53
+ F.from_json(F.col("value").cast("string"), schema).alias("data"),
54
+ F.col("timestamp").alias("kafka_timestamp"),
55
+ F.col("partition"),
56
+ F.col("offset")
57
+ ).select("kafka_key", "data.*", "kafka_timestamp", "partition", "offset")
58
+ ```
59
+
60
+ ```scala
61
+ // Scala Kafka source
62
+ val df = spark.readStream
63
+ .format("kafka")
64
+ .option("kafka.bootstrap.servers", "broker1:9092,broker2:9092")
65
+ .option("subscribe", "topic1")
66
+ .option("startingOffsets", "latest")
67
+ .load()
68
+
69
+ val parsed = df.select(
70
+ col("key").cast("string"),
71
+ from_json(col("value").cast("string"), schema).as("data")
72
+ ).select("key", "data.*")
73
+ ```
74
+
75
+ ### File Source (Auto-Discovery)
76
+
77
+ ```python
78
+ # Read new files as they arrive
79
+ df = spark.readStream \
80
+ .format("parquet") \
81
+ .schema(my_schema) \
82
+ .option("path", "s3://bucket/incoming/") \
83
+ .option("maxFilesPerTrigger", 100) \
84
+ .load()
85
+
86
+ # For JSON files
87
+ df = spark.readStream \
88
+ .format("json") \
89
+ .schema(my_schema) \
90
+ .option("path", "s3://bucket/incoming/") \
91
+ .load()
92
+
93
+ # CSV with header
94
+ df = spark.readStream \
95
+ .format("csv") \
96
+ .schema(my_schema) \
97
+ .option("path", "s3://bucket/incoming/") \
98
+ .option("header", "true") \
99
+ .load()
100
+ ```
101
+
102
+ ### Rate Source (Testing)
103
+
104
+ ```python
105
+ # Generate test data at specified rate
106
+ df = spark.readStream \
107
+ .format("rate") \
108
+ .option("rowsPerSecond", 1000) \
109
+ .option("numPartitions", 10) \
110
+ .load()
111
+
112
+ # Columns: timestamp, value (incrementing long)
113
+ ```
114
+
115
+ ---
116
+
117
+ ## Output Modes
118
+
119
+ ### Append Mode (Default)
120
+
121
+ ```python
122
+ # Only new rows added since last trigger
123
+ # Use when: No aggregations, or windowed aggregations with watermark
124
+ query = df.writeStream \
125
+ .outputMode("append") \
126
+ .format("parquet") \
127
+ .option("path", "s3://bucket/output/") \
128
+ .option("checkpointLocation", "s3://bucket/checkpoints/") \
129
+ .start()
130
+ ```
131
+
132
+ ### Update Mode
133
+
134
+ ```python
135
+ # Only rows that changed since last trigger
136
+ # Use when: Aggregations, want incremental updates
137
+ query = df.groupBy("user_id").count() \
138
+ .writeStream \
139
+ .outputMode("update") \
140
+ .format("console") \
141
+ .start()
142
+ ```
143
+
144
+ ### Complete Mode
145
+
146
+ ```python
147
+ # Entire result table every trigger
148
+ # Use when: Need full aggregation result each time
149
+ # Warning: Can be expensive for large state
150
+ query = df.groupBy("user_id").count() \
151
+ .writeStream \
152
+ .outputMode("complete") \
153
+ .format("console") \
154
+ .start()
155
+ ```
156
+
157
+ ### Mode Selection Guide
158
+
159
+ | Use Case | Output Mode | Notes |
160
+ |----------|-------------|-------|
161
+ | ETL to files | append | Default, efficient |
162
+ | Windowed aggregations | append | With watermark |
163
+ | Running counts/sums | update | Incremental |
164
+ | Dashboards needing full state | complete | Expensive |
165
+ | Deduplication | append | With dropDuplicates |
166
+
167
+ ---
168
+
169
+ ## Watermarks and Event Time
170
+
171
+ ### Understanding Watermarks
172
+
173
+ Watermarks define how late data can arrive before being dropped. They enable Spark to:
174
+ - Clean up old state (bounded memory)
175
+ - Emit results at appropriate times
176
+ - Handle out-of-order events
177
+
178
+ ### Setting Watermarks
179
+
180
+ ```python
181
+ from pyspark.sql import functions as F
182
+
183
+ # Define watermark on event time column
184
+ df_with_watermark = df \
185
+ .withWatermark("event_time", "10 minutes")
186
+
187
+ # Watermark threshold: max_event_time - 10 minutes
188
+ # Events older than watermark are dropped
189
+ # State older than watermark is cleaned up
190
+ ```
191
+
192
+ ### Watermark Guidelines
193
+
194
+ | Scenario | Watermark Duration | Reasoning |
195
+ |----------|-------------------|-----------|
196
+ | Real-time analytics | 1-5 minutes | Low latency, tolerate minimal late data |
197
+ | Standard ETL | 10-30 minutes | Balance latency and late data |
198
+ | Late-arriving data common | 1-24 hours | Accommodate delayed events |
199
+ | Best-effort real-time | 0 minutes | No late data tolerance |
200
+
201
+ ### Example with Windowed Aggregation
202
+
203
+ ```python
204
+ from pyspark.sql import functions as F
205
+ from pyspark.sql.window import Window
206
+
207
+ # Streaming aggregation with watermark
208
+ result = df \
209
+ .withWatermark("event_time", "10 minutes") \
210
+ .groupBy(
211
+ F.window("event_time", "5 minutes", "1 minute"), # 5-min tumbling window, 1-min slide
212
+ "user_id"
213
+ ) \
214
+ .agg(
215
+ F.count("*").alias("event_count"),
216
+ F.sum("amount").alias("total_amount")
217
+ )
218
+
219
+ # Output schema includes window struct: window.start, window.end
220
+ query = result \
221
+ .select(
222
+ F.col("window.start").alias("window_start"),
223
+ F.col("window.end").alias("window_end"),
224
+ "user_id",
225
+ "event_count",
226
+ "total_amount"
227
+ ) \
228
+ .writeStream \
229
+ .outputMode("append") \
230
+ .format("parquet") \
231
+ .option("path", "s3://bucket/windowed_output/") \
232
+ .option("checkpointLocation", "s3://bucket/checkpoints/") \
233
+ .start()
234
+ ```
235
+
236
+ ---
237
+
238
+ ## Windowed Operations
239
+
240
+ ### Tumbling Windows (Non-Overlapping)
241
+
242
+ ```python
243
+ from pyspark.sql import functions as F
244
+
245
+ # 5-minute tumbling windows
246
+ result = df \
247
+ .withWatermark("event_time", "10 minutes") \
248
+ .groupBy(
249
+ F.window("event_time", "5 minutes"),
250
+ "category"
251
+ ) \
252
+ .agg(F.sum("amount").alias("total"))
253
+
254
+ # Windows: [00:00-00:05), [00:05-00:10), [00:10-00:15), ...
255
+ ```
256
+
257
+ ### Sliding Windows (Overlapping)
258
+
259
+ ```python
260
+ # 10-minute windows, sliding every 2 minutes
261
+ result = df \
262
+ .withWatermark("event_time", "10 minutes") \
263
+ .groupBy(
264
+ F.window("event_time", "10 minutes", "2 minutes"),
265
+ "category"
266
+ ) \
267
+ .agg(F.sum("amount").alias("total"))
268
+
269
+ # Windows: [00:00-00:10), [00:02-00:12), [00:04-00:14), ...
270
+ ```
271
+
272
+ ### Session Windows (Gap-Based)
273
+
274
+ ```python
275
+ # Session windows with 5-minute gap threshold
276
+ result = df \
277
+ .withWatermark("event_time", "10 minutes") \
278
+ .groupBy(
279
+ F.session_window("event_time", "5 minutes"), # Spark 3.2+
280
+ "user_id"
281
+ ) \
282
+ .agg(
283
+ F.count("*").alias("events_in_session"),
284
+ F.first("event_time").alias("session_start"),
285
+ F.last("event_time").alias("session_end")
286
+ )
287
+ ```
288
+
289
+ ---
290
+
291
+ ## Stateful Operations
292
+
293
+ ### Aggregations (Built-in State)
294
+
295
+ ```python
296
+ # Running count by key
297
+ running_counts = df \
298
+ .withWatermark("event_time", "1 hour") \
299
+ .groupBy("user_id") \
300
+ .agg(F.count("*").alias("total_events"))
301
+
302
+ # State stored per user_id
303
+ # Cleaned up based on watermark
304
+ ```
305
+
306
+ ### Deduplication
307
+
308
+ ```python
309
+ # Drop duplicates within watermark window
310
+ deduped = df \
311
+ .withWatermark("event_time", "10 minutes") \
312
+ .dropDuplicates(["event_id"]) # Keep first occurrence
313
+
314
+ # Can also dedupe by multiple columns
315
+ deduped = df \
316
+ .withWatermark("event_time", "10 minutes") \
317
+ .dropDuplicates(["user_id", "event_type", "event_time"])
318
+ ```
319
+
320
+ ### Custom Stateful Processing (flatMapGroupsWithState)
321
+
322
+ ```python
323
+ # PySpark - Custom state using applyInPandasWithState (Spark 3.4+)
324
+ from pyspark.sql.streaming.state import GroupState, GroupStateTimeout
325
+
326
+ def update_session_state(
327
+ key: tuple,
328
+ pdf_iter: Iterator[pd.DataFrame],
329
+ state: GroupState
330
+ ) -> Iterator[pd.DataFrame]:
331
+ # Get or initialize state
332
+ if state.exists:
333
+ session_data = state.get
334
+ else:
335
+ session_data = {"count": 0, "total": 0.0}
336
+
337
+ # Process input data
338
+ for pdf in pdf_iter:
339
+ session_data["count"] += len(pdf)
340
+ session_data["total"] += pdf["amount"].sum()
341
+
342
+ # Update state
343
+ state.update(session_data)
344
+
345
+ # Optionally set timeout
346
+ state.setTimeoutDuration(10 * 60 * 1000) # 10 minutes
347
+
348
+ # Yield output
349
+ yield pd.DataFrame([{
350
+ "user_id": key[0],
351
+ "event_count": session_data["count"],
352
+ "total_amount": session_data["total"]
353
+ }])
354
+
355
+ # Apply stateful function
356
+ result = df \
357
+ .withWatermark("event_time", "10 minutes") \
358
+ .groupBy("user_id") \
359
+ .applyInPandasWithState(
360
+ update_session_state,
361
+ outputStructType=output_schema,
362
+ stateStructType=state_schema,
363
+ outputMode="update",
364
+ timeoutConf=GroupStateTimeout.ProcessingTimeTimeout
365
+ )
366
+ ```
367
+
368
+ ```scala
369
+ // Scala flatMapGroupsWithState
370
+ import org.apache.spark.sql.streaming.{GroupState, GroupStateTimeout}
371
+
372
+ case class UserState(count: Long, totalAmount: Double)
373
+ case class UserOutput(userId: String, count: Long, totalAmount: Double)
374
+
375
+ def updateState(
376
+ userId: String,
377
+ events: Iterator[Event],
378
+ state: GroupState[UserState]
379
+ ): Iterator[UserOutput] = {
380
+
381
+ val currentState = state.getOption.getOrElse(UserState(0, 0.0))
382
+
383
+ var newCount = currentState.count
384
+ var newTotal = currentState.totalAmount
385
+
386
+ events.foreach { event =>
387
+ newCount += 1
388
+ newTotal += event.amount
389
+ }
390
+
391
+ val newState = UserState(newCount, newTotal)
392
+ state.update(newState)
393
+ state.setTimeoutDuration("10 minutes")
394
+
395
+ Iterator(UserOutput(userId, newCount, newTotal))
396
+ }
397
+
398
+ val result = df
399
+ .withWatermark("event_time", "10 minutes")
400
+ .as[Event]
401
+ .groupByKey(_.userId)
402
+ .flatMapGroupsWithState(
403
+ OutputMode.Update,
404
+ GroupStateTimeout.ProcessingTimeTimeout
405
+ )(updateState)
406
+ ```
407
+
408
+ ---
409
+
410
+ ## Streaming Joins
411
+
412
+ ### Stream-Static Join
413
+
414
+ ```python
415
+ # Join streaming data with static lookup table
416
+ static_df = spark.read.parquet("s3://bucket/lookup/")
417
+
418
+ # Streaming df joined with static - no watermark needed
419
+ result = streaming_df.join(static_df, "join_key", "left")
420
+
421
+ # Static table can be periodically refreshed
422
+ # Use broadcast for small static tables
423
+ from pyspark.sql.functions import broadcast
424
+ result = streaming_df.join(broadcast(static_df), "join_key")
425
+ ```
426
+
427
+ ### Stream-Stream Join
428
+
429
+ ```python
430
+ # Join two streams - requires watermarks on both
431
+ from pyspark.sql import functions as F
432
+
433
+ stream1 = spark.readStream.format("kafka")...
434
+ stream2 = spark.readStream.format("kafka")...
435
+
436
+ # Both streams need watermarks
437
+ stream1_wm = stream1.withWatermark("event_time", "10 minutes")
438
+ stream2_wm = stream2.withWatermark("event_time", "10 minutes")
439
+
440
+ # Inner join with time constraint
441
+ result = stream1_wm.join(
442
+ stream2_wm,
443
+ F.expr("""
444
+ stream1.user_id = stream2.user_id AND
445
+ stream1.event_time >= stream2.event_time AND
446
+ stream1.event_time <= stream2.event_time + INTERVAL 5 MINUTES
447
+ """),
448
+ "inner"
449
+ )
450
+
451
+ # Left outer join (Spark 2.3+)
452
+ result = stream1_wm.join(
453
+ stream2_wm,
454
+ F.expr("""
455
+ stream1.user_id = stream2.user_id AND
456
+ stream1.event_time >= stream2.event_time - INTERVAL 5 MINUTES AND
457
+ stream1.event_time <= stream2.event_time + INTERVAL 5 MINUTES
458
+ """),
459
+ "leftOuter"
460
+ )
461
+ ```
462
+
463
+ ### Join Type Support
464
+
465
+ | Join Type | Stream-Static | Stream-Stream |
466
+ |-----------|---------------|---------------|
467
+ | Inner | Yes | Yes |
468
+ | Left Outer | Yes | Yes (Spark 2.3+) |
469
+ | Right Outer | Yes | Yes (Spark 2.3+) |
470
+ | Full Outer | Yes | Yes (Spark 2.4+) |
471
+ | Left Semi | Yes | Not supported |
472
+ | Left Anti | Yes | Not supported |
473
+
474
+ ---
475
+
476
+ ## Sinks
477
+
478
+ ### Kafka Sink
479
+
480
+ ```python
481
+ # Write to Kafka
482
+ query = df \
483
+ .select(
484
+ F.col("user_id").alias("key"),
485
+ F.to_json(F.struct("*")).alias("value")
486
+ ) \
487
+ .writeStream \
488
+ .format("kafka") \
489
+ .option("kafka.bootstrap.servers", "broker1:9092") \
490
+ .option("topic", "output_topic") \
491
+ .option("checkpointLocation", "s3://bucket/checkpoints/") \
492
+ .start()
493
+ ```
494
+
495
+ ### File Sink (Parquet, JSON, CSV)
496
+
497
+ ```python
498
+ # Parquet sink with partitioning
499
+ query = df.writeStream \
500
+ .format("parquet") \
501
+ .option("path", "s3://bucket/output/") \
502
+ .option("checkpointLocation", "s3://bucket/checkpoints/") \
503
+ .partitionBy("date", "hour") \
504
+ .trigger(processingTime="1 minute") \
505
+ .start()
506
+
507
+ # JSON sink
508
+ query = df.writeStream \
509
+ .format("json") \
510
+ .option("path", "s3://bucket/output/") \
511
+ .option("checkpointLocation", "s3://bucket/checkpoints/") \
512
+ .start()
513
+ ```
514
+
515
+ ### Delta Lake Sink
516
+
517
+ ```python
518
+ # Delta Lake (ACID transactions, schema evolution)
519
+ query = df.writeStream \
520
+ .format("delta") \
521
+ .outputMode("append") \
522
+ .option("path", "s3://bucket/delta_table/") \
523
+ .option("checkpointLocation", "s3://bucket/checkpoints/") \
524
+ .option("mergeSchema", "true") \
525
+ .start()
526
+
527
+ # Upsert with foreachBatch
528
+ def upsert_to_delta(batch_df, batch_id):
529
+ delta_table = DeltaTable.forPath(spark, "s3://bucket/delta_table/")
530
+ delta_table.alias("target").merge(
531
+ batch_df.alias("source"),
532
+ "target.id = source.id"
533
+ ).whenMatchedUpdateAll() \
534
+ .whenNotMatchedInsertAll() \
535
+ .execute()
536
+
537
+ query = df.writeStream \
538
+ .foreachBatch(upsert_to_delta) \
539
+ .option("checkpointLocation", "s3://bucket/checkpoints/") \
540
+ .start()
541
+ ```
542
+
543
+ ### Custom Sink (foreachBatch)
544
+
545
+ ```python
546
+ def write_to_database(batch_df, batch_id):
547
+ """Write each micro-batch to external database."""
548
+ batch_df.write \
549
+ .format("jdbc") \
550
+ .option("url", "jdbc:postgresql://host:5432/db") \
551
+ .option("dbtable", "output_table") \
552
+ .option("user", "user") \
553
+ .option("password", "password") \
554
+ .mode("append") \
555
+ .save()
556
+
557
+ query = df.writeStream \
558
+ .foreachBatch(write_to_database) \
559
+ .option("checkpointLocation", "s3://bucket/checkpoints/") \
560
+ .trigger(processingTime="30 seconds") \
561
+ .start()
562
+ ```
563
+
564
+ ### foreach (Row-by-Row)
565
+
566
+ ```python
567
+ # For custom processing of each row
568
+ class ForeachWriter:
569
+ def open(self, partition_id, epoch_id):
570
+ # Initialize connection
571
+ self.connection = create_connection()
572
+ return True
573
+
574
+ def process(self, row):
575
+ # Process each row
576
+ self.connection.insert(row.asDict())
577
+
578
+ def close(self, error):
579
+ # Clean up
580
+ self.connection.close()
581
+
582
+ query = df.writeStream \
583
+ .foreach(ForeachWriter()) \
584
+ .start()
585
+ ```
586
+
587
+ ---
588
+
589
+ ## Triggers
590
+
591
+ ### Available Trigger Types
592
+
593
+ ```python
594
+ # Process as fast as possible (default)
595
+ query = df.writeStream.trigger(processingTime="0 seconds").start()
596
+
597
+ # Fixed interval
598
+ query = df.writeStream.trigger(processingTime="1 minute").start()
599
+
600
+ # Once - process all available data, then stop
601
+ query = df.writeStream.trigger(once=True).start()
602
+
603
+ # Available now - process all available data (Spark 3.3+)
604
+ query = df.writeStream.trigger(availableNow=True).start()
605
+
606
+ # Continuous processing (experimental, low latency)
607
+ query = df.writeStream.trigger(continuous="1 second").start()
608
+ ```
609
+
610
+ ### Trigger Selection Guide
611
+
612
+ | Trigger | Use Case |
613
+ |---------|----------|
614
+ | processingTime="0 seconds" | Maximum throughput |
615
+ | processingTime="N seconds" | Controlled resource usage |
616
+ | once=True | Batch-style processing |
617
+ | availableNow=True | Catch-up processing |
618
+ | continuous="N ms" | Ultra-low latency (experimental) |
619
+
620
+ ---
621
+
622
+ ## Monitoring and Management
623
+
624
+ ### Query Management
625
+
626
+ ```python
627
+ # Start query and get handle
628
+ query = df.writeStream.format("console").start()
629
+
630
+ # Query properties
631
+ print(f"Query ID: {query.id}")
632
+ print(f"Run ID: {query.runId}")
633
+ print(f"Name: {query.name}")
634
+ print(f"Is Active: {query.isActive}")
635
+ print(f"Status: {query.status}")
636
+ print(f"Last Progress: {query.lastProgress}")
637
+ print(f"Recent Progress: {query.recentProgress}")
638
+
639
+ # Wait for termination
640
+ query.awaitTermination()
641
+ query.awaitTermination(timeout=60) # With timeout
642
+
643
+ # Stop query
644
+ query.stop()
645
+
646
+ # Get exception if failed
647
+ exception = query.exception()
648
+ ```
649
+
650
+ ### Progress Monitoring
651
+
652
+ ```python
653
+ # Get latest progress
654
+ progress = query.lastProgress
655
+ if progress:
656
+ print(f"Input rows/sec: {progress['inputRowsPerSecond']}")
657
+ print(f"Processed rows/sec: {progress['processedRowsPerSecond']}")
658
+ print(f"Batch ID: {progress['batchId']}")
659
+ print(f"Duration: {progress['batchDuration']} ms")
660
+ print(f"State rows: {progress['stateOperators']}")
661
+
662
+ # Custom progress listener
663
+ class ProgressListener:
664
+ def onQueryProgress(self, event):
665
+ print(f"Progress: {event.progress}")
666
+
667
+ def onQueryTerminated(self, event):
668
+ print(f"Terminated: {event.exception}")
669
+
670
+ spark.streams.addListener(ProgressListener())
671
+ ```
672
+
673
+ ### Checkpointing
674
+
675
+ ```python
676
+ # Checkpoint location is required for fault tolerance
677
+ query = df.writeStream \
678
+ .format("parquet") \
679
+ .option("path", "s3://bucket/output/") \
680
+ .option("checkpointLocation", "s3://bucket/checkpoints/query_name/") \
681
+ .start()
682
+
683
+ # Checkpoint contains:
684
+ # - Offsets (what data has been processed)
685
+ # - State (for stateful operations)
686
+ # - Commits (what batches completed)
687
+
688
+ # Recovery: Query restarts from last checkpoint automatically
689
+ # Clean start: Delete checkpoint directory (loses state!)
690
+ ```
691
+
692
+ ---
693
+
694
+ ## Performance Patterns
695
+
696
+ ### Optimizing Throughput
697
+
698
+ ```python
699
+ # 1. Increase Kafka partitions for parallelism
700
+ # Consumer parallelism = Kafka partitions
701
+
702
+ # 2. Tune maxOffsetsPerTrigger
703
+ query = df.readStream \
704
+ .format("kafka") \
705
+ .option("maxOffsetsPerTrigger", 500000) \ # More data per batch
706
+ .load()
707
+
708
+ # 3. Optimize shuffle partitions
709
+ spark.conf.set("spark.sql.shuffle.partitions", 100)
710
+
711
+ # 4. Use appropriate trigger interval
712
+ query = df.writeStream \
713
+ .trigger(processingTime="30 seconds") \
714
+ .start()
715
+
716
+ # 5. Enable AQE for dynamic optimization
717
+ spark.conf.set("spark.sql.adaptive.enabled", "true")
718
+ ```
719
+
720
+ ### Managing State Size
721
+
722
+ ```python
723
+ # 1. Always use watermarks for stateful operations
724
+ df.withWatermark("event_time", "1 hour")
725
+
726
+ # 2. Monitor state size in progress
727
+ progress = query.lastProgress
728
+ for operator in progress["stateOperators"]:
729
+ print(f"State rows: {operator['numRowsTotal']}")
730
+ print(f"Memory used: {operator['memoryUsedBytes']}")
731
+
732
+ # 3. Configure state store
733
+ spark.conf.set("spark.sql.streaming.stateStore.providerClass",
734
+ "org.apache.spark.sql.execution.streaming.state.RocksDBStateStoreProvider")
735
+ # RocksDB handles larger state better than in-memory default
736
+
737
+ # 4. Set state cleanup mode
738
+ spark.conf.set("spark.sql.streaming.stateStore.stateSchemaCheck", "false")
739
+ ```
740
+
741
+ ---
742
+
743
+ ## Common Anti-Patterns
744
+
745
+ ```python
746
+ # BAD: No watermark with aggregation
747
+ df.groupBy("user_id").count() # Unbounded state growth!
748
+
749
+ # GOOD: Always use watermark
750
+ df.withWatermark("event_time", "1 hour").groupBy("user_id").count()
751
+
752
+ # BAD: Complete mode with large state
753
+ df.groupBy("user_id").count().writeStream.outputMode("complete") # Outputs entire state
754
+
755
+ # GOOD: Update mode for incremental
756
+ df.groupBy("user_id").count().writeStream.outputMode("update")
757
+
758
+ # BAD: No checkpoint location
759
+ query = df.writeStream.format("console").start() # No fault tolerance!
760
+
761
+ # GOOD: Always specify checkpoint
762
+ query = df.writeStream.format("console") \
763
+ .option("checkpointLocation", "/checkpoints/query") \
764
+ .start()
765
+
766
+ # BAD: foreach for high-throughput
767
+ df.writeStream.foreach(process_row).start() # Row-by-row overhead
768
+
769
+ # GOOD: foreachBatch for batched processing
770
+ df.writeStream.foreachBatch(process_batch).start() # Batch-level efficiency
771
+ ```
772
+
773
+ ---
774
+
775
+ ## Best Practices Summary
776
+
777
+ 1. **Always use watermarks** - Prevents unbounded state growth
778
+ 2. **Choose appropriate output mode** - Append for ETL, Update for aggregations
779
+ 3. **Set checkpoint locations** - Required for fault tolerance
780
+ 4. **Use foreachBatch over foreach** - Better performance for custom sinks
781
+ 5. **Monitor state size** - Watch for memory growth in progress metrics
782
+ 6. **Tune trigger intervals** - Balance latency vs throughput
783
+ 7. **Match Kafka partitions to parallelism** - Consumer tasks = Kafka partitions
784
+ 8. **Use stream-static joins when possible** - Simpler than stream-stream
785
+ 9. **Test with production data rates** - Performance varies with volume
786
+ 10. **Enable structured streaming UI** - Detailed metrics in Spark UI