Skip to content

feat: add prepared statement support (prepare/query_prepared)#126

Open
Taure wants to merge 3 commits intoerleans:mainfrom
Taure:feat/prepared-statements
Open

feat: add prepared statement support (prepare/query_prepared)#126
Taure wants to merge 3 commits intoerleans:mainfrom
Taure:feat/prepared-statements

Conversation

@Taure
Copy link
Copy Markdown
Contributor

@Taure Taure commented Mar 22, 2026

Summary

  • Add pgo:prepare/2,3 — parse a named prepared statement, returns {ok, Name, ParameterOIDs}
  • Add pgo:query_prepared/3,4 — execute a prepared statement by name, skipping PARSE entirely
  • Add pgo_prepared_cache module — ETS-based cache for statement metadata
  • 13 new Common Test cases

Motivation

pgo currently uses unnamed statements ("") for every query, forcing PostgreSQL to parse and plan each one. Named prepared statements allow skipping the PARSE step on repeated queries, sending only BIND→DESCRIBE→EXECUTE→SYNC.

Benchmarks with erlperf show:

  • select_one_by_id: +65% throughput (6,500 → 10,700 ops/sec)
  • count(*): +61% (7,300 → 11,800 ops/sec)
  • select 100 rows: +20% (1,500 → 1,800 ops/sec)

Usage

%% Prepare once, execute many times on same connection
pgo:with_conn(default, fun() ->
    {ok, _Name, OIDs} = pgo:prepare("my_query",
        "SELECT * FROM users WHERE id = $1"),
    #{rows := Rows} = pgo:query_prepared("my_query", [42], OIDs)
end).

Test plan

  • 13 new prepared statement CT cases pass
  • All 57 existing tests still pass (70 total)

Add named prepared statement API:
- pgo:prepare/2,3 — parse and cache named statement, returns parameter OIDs
- pgo:query_prepared/3,4 — execute prepared statement (skips PARSE)
- pgo_prepared_cache — ETS-based statement metadata cache

The prepared_query path sends only BIND+DESCRIBE+EXECUTE+SYNC,
skipping the PARSE step entirely. This eliminates server-side query
parsing and planning on repeated queries.

Includes 13 new Common Test cases covering prepare, query_prepared,
error handling, rows_as_maps, and with_conn usage.
@Taure Taure force-pushed the feat/prepared-statements branch from 83a13de to 9f2ff5f Compare March 22, 2026 15:25
Taure added 2 commits March 22, 2026 19:18
query_prepared now transparently prepares statements on connections
that haven't seen them yet. On first use of a connection, it calls
pgo_handler:prepare before executing. Subsequent calls on the same
connection skip the prepare step via ETS-based tracking.

- pgo_prepared_cache tracks {ConnectionPid, StatementName} pairs
- maybe_prepare_on_conn/3 handles auto-prepare in pgo:query_prepared
- Handles "already prepared" (42P05) gracefully
- New test: auto_prepare_across_pool with pool_size=5 and 20 queries
Use edoc comments instead of -doc/-moduledoc attributes for
OTP 26 compatibility.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant