Hide navigation sidebar

Hide table of contents sidebar

Toggle site navigation sidebar

Flowman documentation

Toggle table of contents sidebar

Quick Start Guide

Flowman Quick Start Guide

Concepts

Core Concepts
Main Entities
Lifecycles and Phases
Execution and Data Metrics
Schema Migrations

Tutorial

Flowman Tutorial
Lesson 1 — Flowman Basics
Lesson 2 — Schema Definitions
Lesson 3 — Transformations
Lesson 4 — Parameters
Lesson 5 — Multiple Build Targets
Lesson 6 — Flowshell
Lesson 7 — Execution Phases and Lifecycles
Lesson 12 — Deployment

Command Line Tools

Flowman CLI Tools
Flowman Executor (flowexec)
Toggle navigation of Flowman Executor (flowexec)
Flowman Interactive Shell (flowshell)
Flowman Kernel Server (flowman-kernel)
Flowman Interactive Remote Shell (flowrshell)
Flowman History Server (flowman-server)
Flowman Schema Generator

Workflow

Development & Deployment Workflow
Using Standard Maven Plugins
Using Flowman Maven Plugin

Reference Documentation

Reference Documentation
Projects
Modules
Mappings
Toggle navigation of Mappings
Relations
Toggle navigation of Relations
Targets
Toggle navigation of Targets
Jobs
Toggle navigation of Jobs
- Flowman Job Execution
Datasets
Toggle navigation of Datasets
Schemas
Toggle navigation of Schemas
Connections
Toggle navigation of Connections
- JDBC Connection
- SSH Connection
Tests
Toggle navigation of Tests
- Flowman Test Execution
Assertions
Toggle navigation of Assertions
Measures
Toggle navigation of Measures
- SQL Measure
Templates
Toggle navigation of Templates
Execution Metrics
Toggle navigation of Execution Metrics
Execution Hooks
Toggle navigation of Execution Hooks
Namespace
Fields, Data Types & Values
Script Expressions
Profiles

Testing

Testing with Flowman

Documenting

Documenting your Project
Checking Model Properties
Configuring the Documentation
Documenting Mappings
Documenting Relations
Documenting Targets

Setup & Configuration

Setup & Configuration
Installation Guide
Running Flowman in Docker
Running Flowman on Windows
Deploying Flowman to AWS EMR
Deploying Flowman to Azure Synapse
Configuration Properties
Building Flowman from Sources

Cookbooks

Advanced JDBC Database Features
Data Quality Checks
Data Validation before Build
Execution Metrics
Execution Phases
Hadoop Dependencies Installation
Impala Metadata
Kerberos Authentication
Override jar versions
Parallel Execution
Performance Tuning
Securely providing Secrets
Sharing Entities between Projects
Syntax Highlighting
Target Execution Ordering

Connectors & Plugins

Connectors
Plugins
Toggle navigation of Plugins

Misc

FAQ
Releases

v: latest

Versions: latest; stable; build-docs-with-poetry; branch-1.0; branch-0.30

Downloads

On Read the Docs: Project Home; Builds

Toggle table of contents sidebar

Put File Target#

Relation Target

Merge Files Target

Copyright © 2023, The Flowman Authors

Made with Sphinx and @pradyunsg's Furo