Skip to content
This site documents the development version of Orcapod (the main branch), which may differ from the latest release. For the releases, see PyPI and the changelog.

API Reference

This section contains the full API reference for Orcapod, auto-generated from source code docstrings.

The top-level orcapod namespace exposes the most commonly used entry points directly:

Symbol Description
FunctionPod Wraps a Python function to transform data in a stream
function_pod Decorator that attaches a FunctionPod to a callable
Pipeline A pipeline blueprint: records which pods are applied to which streams
PipelineJob A pipeline bound to sources and a database; the object you run
side_effect_pod, sink_pod, tap_pod Decorators for functions run for their side effects

Everything else lives in subpackages:

Subpackage Description
orcapod.sources Source classes for ingesting external data into pipelines
orcapod.operators Structural stream transformations (join, filter, select, batch, etc.)
orcapod.databases Persistent storage backends for computation results
orcapod.nodes Pipeline graph elements, including the DB-backed job nodes
orcapod.streams Immutable (Tag, Data) sequences backed by PyArrow tables
orcapod.types Core type definitions: Schema, ColumnConfig, ContentHash