Agent Skill · RisingWave
risingwave-best-practices
Use when designing RisingWave schemas, writing materialized views, configuring sources or sinks, optimizing streaming SQL performance, troubleshooting slow backfills, setting up CDC, designing time-windowed aggregations, or reviewing a RisingWave streaming pipeline
Skill body
RisingWave Best Practices
14 rules covering schema design, streaming SQL patterns, sink configuration, and performance.
How to Apply
- Read the relevant rule files for the review type below
- Apply rules to the design or code under review
- Explain violations with their impact and the fix
Review Procedures
Schema Review
- schema-source-vs-table.md — SOURCE vs TABLE selection
- schema-append-only.md — APPEND ONLY for immutable streams
- schema-watermark.md — Watermark placement
Materialized View Review
- mv-emit-on-window-close.md — EOWC for windowed queries
- mv-background-ddl.md — Non-blocking DDL for large tables
- mv-no-order-by.md — ORDER BY in MVs
Streaming SQL Review
- stream-tumble-windows.md — Time window functions
- stream-cdc-pattern.md — Two-step CDC setup
- stream-temporal-join.md — Joining streams with CDC tables
Sink Review
- sink-snapshot-false.md — Prevent backfill duplicates
- sink-force-compaction.md — Reduce output volume
Performance Review
- perf-shared-source.md — Shared Kafka source
- perf-indexes-on-mv.md — Indexes on materialized views
- perf-parallelism.md — MV parallelism tuning
Rule Categories
| Priority | Category | Impact | Prefix | Rules |
|---|---|---|---|---|
| 1 | Schema Design | CRITICAL / HIGH | schema- |
3 |
| 2 | Materialized Views | CRITICAL / HIGH | mv- |
3 |
| 3 | Streaming SQL | CRITICAL / HIGH | stream- |
3 |
| 4 | Sink Configuration | HIGH / MEDIUM | sink- |
2 |
| 5 | Performance | HIGH / MEDIUM | perf- |
3 |
Quick Reference
Schema:
schema-source-vs-table— CDC requires TABLE; SOURCE is for append-only streamsschema-append-only— APPEND ONLY enables optimizations; use for immutable event dataschema-watermark— Define watermarks at ingestion point (source/table), not in MVs
Materialized Views:
mv-emit-on-window-close— Use EOWC for final window results; default emits partial updatesmv-background-ddl— SET BACKGROUND_DDL=true before creating MVs over large tablesmv-no-order-by— ORDER BY in MV applies only at creation, not to ongoing results
Streaming SQL:
stream-tumble-windows— Use TUMBLE/HOP/SESSION, not date_trunc, for streaming windowsstream-cdc-pattern— Two-step: CREATE SOURCE (shared) → CREATE TABLE … FROM sourcestream-temporal-join— Join streaming source with CDC table using FOR SYSTEM_TIME AS OF
Sinks:
sink-snapshot-false— Always usesnapshot = falsewhen adding sinks to existing MVssink-force-compaction— Useforce_compaction = truefor high-cardinality upsert sinks
Performance:
perf-shared-source— Multiple MVs from one Kafka topic should use shared sourceperf-indexes-on-mv— Create indexes on MV columns used in WHERE/JOIN predicatesperf-parallelism— Increase parallelism for high-throughput MVs
Skill frontmatter
license: Apache-2.0
metadata: {"author" => "RisingWave Labs", "version" => "0.3.1", "organization" => "RisingWave Labs", "date" => "April 2026", "abstract" => "14 best-practice rules for RisingWave covering schema design, materialized view patterns, CDC setup, streaming SQL patterns, sink configuration, and performance optimization. Rules are organized by category and impact level (CRITICAL > HIGH > MEDIUM)."}
Work with this as data
Every skill here is available over the APIs.io API and to AI agents over MCP.