Skip to content

# Reference

Find precise technical information about pgflow’s APIs, configuration options, and internal components.

## Security

Section titled “Security”
Permissions Database permission requirements for client access, Edge Workers, and security configuration

## Configuration

Section titled “Configuration”
Overview Learn how pgflow configuration is structured and when to use each option
Step Execution Options Configure retry behavior, timeouts, and error handling for flow steps
Worker Configuration Runtime settings for Edge Worker including concurrency and database connections

## APIs

Section titled “APIs”
@pgflow/client API TypeScript client for starting flows and streaming real-time progress
Context API Reference Complete reference for all properties available in the handler context object
Compile API Generate SQL statements from Flow definitions programmatically
Manual installation Install pgflow without the CLI using manual SQL execution

## Queue Worker

Section titled “Queue Worker”
Configuration Configuration options for using Edge Worker in queue-only mode
How it works Internal implementation details of the Edge Worker task queue system