Skip to main content

Module http_gateway

Module http_gateway 

Source
Expand description

HTTP SQL gateway — @neondatabase/serverless-compatible.

When [http_gateway] enabled = true, the proxy exposes a POST /sql endpoint that runs one SQL statement over the backend PG-wire client and returns a Neon-style JSON result ({ command, rowCount, rows, fields }). This lets edge/serverless runtimes (Cloudflare Workers, Vercel Edge) that cannot hold a TCP socket talk to vanilla PostgreSQL or HeliosDB-Nano over plain HTTP.

Parameterised queries ($1,$2) are supported via a JSON params array. Neon-Array-Mode: true returns each row as an array instead of an object. A WebSocket session/transaction mode is the planned follow-on; this is the one-shot HTTP path the serverless driver uses for non-transactional queries.

Structs§

HttpGateway