Developer Documentation

Welcome to the Qarion ETL developer documentation! This documentation is for developers working on or extending the Qarion ETL framework.

Note: This is developer documentation for the Qarion ETL codebase. For user documentation on how to use Qarion ETL, see User Documentation.

Quick Start

1. Development Setup - Setting up a development environment
2. Architecture Overview - System architecture and design principles
3. Plugin System Overview - Understanding the plugin architecture

Documentation Structure

Architecture & Guides

• Architecture Overview - System architecture and design principles
• Code Guide - Code structure, patterns, and navigation guide
• Flow System - Flow architecture and patterns (developer perspective)
• Code Generation System - How code generation works
• Core Concepts - Core concepts from developer perspective
• Configuration - Configuration system architecture
• Testing - Testing architecture and practices

Plugin Development

• Plugin System Overview - Understanding the plugin architecture
• Engine Plugins - Developing engine plugins
• Repository Plugins - Developing repository plugins
• Code Generator Plugins - Developing code generator plugins
• Task Type Plugins - Developing task type plugins

Note: Plugin documentation is in developer/plugins/, development guides are in developer/development/.

Features

• Flow System Architecture - Flow system implementation details
• Transformations - Transformation system
• Load Planning - Load planning system
• Export System - Export functionality
• Input Validation - Input validation
• Contracts - Data contract validation
• Credential Store Architecture - Credential store system
• Triggers Architecture - Trigger system implementation
• Task Documentation - Task system documentation
• Documentation Generator - Documentation generator architecture

Development

• Development Setup - Setting up a development environment
• Contributing - Contributing to Qarion ETL
• Code Style - Coding standards and conventions
• Testing Guide - Writing and running tests
• Credential Store Development - Credential store development

API Reference

• CLI Commands - Command-line interface reference
• Python API - Python API documentation
• Plugin Interfaces - Plugin interface specifications

Note: All paths are relative to docs/developer/. API documentation is in developer/api/, development guides are in developer/development/, and plugin documentation is in developer/plugins/.

Architecture

• Architecture Overview - System architecture (if exists)

Testing

• Testing Guide - Testing guidelines and practices (if exists)

Configuration

• Storage Configuration - Storage backend configuration (if exists)

Related Documentation

• User Documentation - For users of Qarion ETL
• Main README - Project overview