ETLRelay¶
ETLRelay is an open-source Python framework for composing lightweight, batch-oriented extract, transform, and load (ETL) pipelines.
Its core execution model is:
Source → Processor(s) → Sink
A source produces batches, processors transform them, and a sink consumes the processed output. File workflows keep storage access independent of format-specific reading and writing.
Current release: 0.8.0¶
ETLRelay v0.8.0 focuses on security, operational reliability, and release readiness.
Building on the YAML configuration and CLI functionality introduced in v0.6.0 and v0.7.0, this release strengthens:
- Local filesystem path validation and documented security boundaries.
- YAML configuration validation and SQL connection-reference preflight.
- Operational logging, CLI error reporting, and sensitive-data disclosure controls.
- Pipeline iterator cleanup and file/SQL resource ownership.
- File overwrite behavior, SQL transaction boundaries, empty-batch handling, and schema compatibility.
- Dependency auditing, built-distribution verification, and clean-environment installed-wheel testing.
- Compatibility verification across supported Python versions and CI platforms.
The release retains YAML schema version 1 and the existing Python and CLI interfaces.
ETLRelay does not provide a general-purpose security sandbox, database authorization layer, atomic file replacement, or pipeline-wide transactions.
Current capabilities¶
ETLRelay includes:
- Arrow-backed
Batchdata and synchronous pipeline execution. - The
etlrelayCLI withrun,validate,version, andhelpcommands. - Local filesystem access with resolved-path containment validation.
- CSV and Parquet reading and writing.
- Column selection, column renaming, and row filtering processors.
- SQLAlchemy-backed
SqlSourceand append-onlySqlSink. - YAML configuration schema version
1with explicit component validation. ComponentCatalogandPipelineBuilderfor configuration-built pipelines.- Resource lifecycle management and documented error propagation.
- Unit, integration, functional, and installed-distribution tests.
SQLite is the reference SQL integration-test backend. Other SQLAlchemy dialects require appropriate drivers and application-level verification.
ETLRelay supports CPython 3.12, 3.13, and 3.14. The complete test suite runs on Python 3.12, with additional installed-wheel compatibility checks for newer Python versions and selected operating systems.
Documentation¶
- Getting Started — create and run YAML- or Python-defined pipelines.
- CLI Reference — command usage, validation, execution, and exit codes.
- YAML Configuration — schema version
1, supported properties, preflight behavior, and limitations. - Core Concepts — batches, processors, schemas, and file formats.
- Security — implemented controls, security boundaries, and deferred risks.
- Logging — operational events, logging configuration, and error reporting.
- API Reference — public Python interfaces and implementations.
- Development — development environment and verification commands.
- Release Automation — CI checks and publication workflow.
- Pipeline Architecture — execution, schema validation, and iterator cleanup.
- Configuration Loading — loading, validation, construction, and execution boundaries.
- Configuration Validation — schema and component validation.
- Component Registry — registrations, factories, and component catalog.
- Reader and Writer Contracts — stream ownership and format behavior.
- SQL Source and Sink — SQL parameterization, resources, and transactions.
- Roadmap — released milestones and the remaining v1.0 roadmap.
Scope and limitations¶
YAML schema version 1 supports file and SQL sources/sinks, local CSV/Parquet workflows, and the built-in select_columns, rename_columns, and filter_rows processors.
The configuration model uses explicit registrations rather than arbitrary dynamic imports or a general-purpose plugin system.
The validate command checks configuration and construction without executing the data pipeline. Runtime failures remain possible because successful preflight does not guarantee data compatibility, filesystem availability, or database connectivity.
File writes are non-atomic, and SQL sink transactions operate per nonempty batch. ETLRelay does not automatically retry failed operations or roll back earlier persisted output.
S3, HDFS, and other remote-storage integrations remain outside the planned v1.0.0 scope.
ETLRelay is experimental pre-1.0 software. Its public APIs may evolve, and users should assess deployment security and operational requirements before processing sensitive or production data.