Sample Applications
This guide provides practical examples of NPipeline implementations, organized by skill level and complexity. Each sample demonstrates specific concepts and patterns you can apply to your own pipelines.
Location: All samples are located in the
/samples/directory of the repository. Each sample includes complete source code, configuration files, and a README with detailed explanations.
Recommended Learning Path
New to NPipeline? Follow this path to master the framework:
-
Start Here: Sample 01: Basic Pipeline (1-2 hours)
- Learn the fundamentals: sources, transforms, sinks, and how data flows
- This is your "Hello World" of NPipeline
-
Build Your Foundation: Samples 2-5 (2-3 hours)
- File processing, error handling, data transformation, and parallelism
- Strengthen core concepts with hands-on examples
-
Add Resilience: Sample 06: Advanced Error Handling (1 hour)
- Learn production-ready error recovery patterns
- Understand retries and circuit breakers
-
Choose Your Focus (ongoing)
- Data Processing → Samples 7-9 - Enrichment, CSV, analytics
- Performance → Samples 11-12 - Custom nodes, optimization
- Streaming → Samples 15-16 - Windowing, time-based processing
- Complex Joins → Samples 17-20 - Keyed joins, temporal logic
- Extensions → Extension Samples - Lineage, observability, composition, nodes
Already know what you need?
Jump directly to samples by topic:
- File Processing
- CSV Processing
- JSON Processing
- Real-time Analytics
- Custom Node Implementation
- Extension Samples
What Each Sample Includes
Every sample comes with:
- Complete source code with comments explaining key concepts
- Configuration files showing best practices
- README with detailed explanations and setup instructions
- Performance characteristics and tuning guidance
- Real-world scenario context and business logic
Sample Breakdown by Skill Level
Basic Samples (1-5)
Perfect for learning NPipeline fundamentals:
- Sample 01: Basic Pipeline - Hello World of NPipeline
- Sample 02: File Processing - Stream processing files efficiently
- Sample 03: Basic Error Handling - Essential error handling patterns
- Sample 04: Simple Data Transformation - Validation, filtering, enrichment
- Sample 05: Parallel Processing - Leveraging multiple CPU cores
Intermediate Samples (6-11)
Building real-world features:
- Sample 06: Advanced Error Handling - Production resilience patterns
- Sample 07: LookupNode - Data enrichment from external sources
- Sample 08: CSV Connector - CSV processing pipelines
- Sample 09: JSON Connector - JSON array and NDJSON processing pipelines
- Sample 10: AggregateNode - Real-time analytics with windowing
- Sample 11: BranchNode - Parallel data distribution
→ View all Intermediate Samples
Advanced Samples (11-23)
Production-grade scenarios:
- 11-12: Foundational concepts (custom nodes, performance optimization)
- 13-14: Data processing patterns (batching, unbatching)
- 15-16: Stream processing and windowing (time-based, session-based, dynamic)
- 17-20: Complex joins and merging (keyed, temporal, custom merge)
- 21-23: Event-time processing, monitoring, end-to-end scenarios
Extension Samples
Demonstrating NPipeline extension packages:
- Lineage Extension - Data lineage tracking and provenance
- Nodes Extension - Pre-built data processing nodes
- Observability Extension - Metrics collection and monitoring
- Composition Extension - Hierarchical pipeline composition
Learning Paths
Choose the path that matches your goals:
Minimum Path (1-2 hours)
Get started quickly with essentials:
- Sample 01: Basic Pipeline
- Sample 03: Basic Error Handling
- Sample 04: Simple Data Transformation
Foundation Path (4-5 hours)
Build a solid understanding:
- All Basic Samples (1-5)
- Sample 06: Advanced Error Handling
- Sample 07: LookupNode
- Sample 08: CSV Connector
- Sample 09: JSON Connector
- Sample 10: AggregateNode
Comprehensive Path (8+ hours)
Master all patterns:
- All Basic Samples (1-5)
- All Intermediate Samples (6-11)
- All Advanced Samples (12-23)
- All Extension Samples
Extension-Focused Path (3-4 hours)
Master extension packages:
- All Basic Samples (1-5)
- Sample 06: Advanced Error Handling
- Sample 07: LookupNode
- Sample 08: CSV Connector
- Sample 09: JSON Connector
- All Extension Samples
Related Documentation
- Core Concepts - Learn fundamental NPipeline concepts
- Architecture - Understand how NPipeline works internally
- Advanced Topics - Master performance optimization and production patterns
- Extensions - Discover available extension packages