Documentation

Everything you need to build, deploy, and scale your PostgreSQL API with Postrust.

Quick Start

Get your PostgreSQL API running in under 5 minutes with Docker.

$ docker run -p 3000:3000 \
  -e DATABASE_URL="..." \
  postrust/postrust

Getting Started

Quick start guide to get your first API running in minutes

Read Getting Started docs

API Reference

Complete reference for REST endpoints, operators, and headers

Read API Reference docs

GraphQL

Full GraphQL API with queries, mutations, subscriptions, and filtering

Read GraphQL docs

Realtime Subscriptions

Live data updates via GraphQL subscriptions and PostgreSQL LISTEN/NOTIFY

Read Realtime Subscriptions docs

pgvector Integration

Vector similarity search for AI apps, semantic search, and RAG pipelines

Read pgvector Integration docs

Custom Routes

Define custom Rust handlers for webhooks, business logic, and more

Read Custom Routes docs

SaaS Domains (Beta)

Multi-tenant custom domains with automatic SSL and dynamic routing

Read SaaS Domains (Beta) docs

Authentication

JWT authentication and PostgreSQL Row-Level Security

Read Authentication docs

Configuration

Environment variables and runtime configuration options

Read Configuration docs

Deployment

Deploy to Docker, AWS Lambda, Kubernetes, and more

Read Deployment docs

Cloudflare Workers

The REST API in a Worker over Hyperdrive, and every way it differs from the server

Read Cloudflare Workers docs

Benchmarks

Measured binary size, latency and memory, and the script that reproduces them

Read Benchmarks docs

Conformance

How closely Postrust matches PostgREST and Hasura, measured against each by replaying its own test suite

Read Conformance docs

PostgREST Conformance

The REST report: what agrees, and where the two differ on purpose

Read PostgREST Conformance docs

Hasura Conformance

The GraphQL report: what agrees, and where the two differ on purpose

Read Hasura Conformance docs

Guides

Row-level security behind an API, GraphQL from a schema, and how the tools compare

Read Guides docs

Need help?

Join our community for support, discussions, and updates.