agora inbox for [email protected]
help / color / mirror / Atom feed[PATCH v8 1/2] Key PGSTAT_KIND_RELATION by relfile locator
223+ messages / 2 participants
[nested] [flat]
* [PATCH v8 1/2] Key PGSTAT_KIND_RELATION by relfile locator
@ 2025-10-01 09:45 Bertrand Drouvot <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Bertrand Drouvot @ 2025-10-01 09:45 UTC (permalink / raw)
This patch changes the key used for the PGSTAT_KIND_RELATION statistic kind.
Instead of the relation oid, it now relies on:
- dboid (linked to RelFileLocator's dbOid)
- objoid which is the result of a new macro (namely RelFileLocatorToPgStatObjid())
that computes an objoid based on the RelFileLocator's spcOid and the
RelFileLocator's relNumber.
That will allow us to add new stats (add writes counters) and ensure that some
counters (n_dead_tup and friends) are replicated.
The patch introduces pgstat_reloid_to_relfilelocator() to 1) avoid calling
RelationIdGetRelation() to get the relfilelocator based on the relation oid
and 2) handle the partitioned table case.
Please note that:
- when running pg_stat_have_stats('relation',...) we now need to be connected
to the database that hosts the relation. As pg_stat_have_stats() is not
documented publicly, then the changes done in 029_stats_restart.pl look
enough.
- this patch does not handle rewrites so some tests are failing. It's only
intent is to ease the review and should not be pushed without being
merged with the following patch that handles the rewrites.
- it can be used to test that stats are incremented correctly and that we're
able to retrieve them as long as rewrites are not involved.
---
src/backend/access/heap/vacuumlazy.c | 3 +-
src/backend/postmaster/autovacuum.c | 9 +-
src/backend/utils/activity/pgstat_relation.c | 234 +++++++++++++++----
src/backend/utils/adt/pgstatfuncs.c | 22 +-
src/include/pgstat.h | 18 +-
src/include/utils/pgstat_internal.h | 1 +
src/test/recovery/t/029_stats_restart.pl | 40 ++--
7 files changed, 249 insertions(+), 78 deletions(-)
3.3% src/backend/postmaster/
64.6% src/backend/utils/activity/
5.3% src/backend/utils/adt/
7.0% src/include/
18.7% src/test/recovery/t/
diff --git a/src/backend/access/heap/vacuumlazy.c b/src/backend/access/heap/vacuumlazy.c
index 62035b7f9c3..a9b2b4e1033 100644
--- a/src/backend/access/heap/vacuumlazy.c
+++ b/src/backend/access/heap/vacuumlazy.c
@@ -961,8 +961,7 @@ heap_vacuum_rel(Relation rel, const VacuumParams params,
* soon in cases where the failsafe prevented significant amounts of heap
* vacuuming.
*/
- pgstat_report_vacuum(RelationGetRelid(rel),
- rel->rd_rel->relisshared,
+ pgstat_report_vacuum(rel->rd_locator,
Max(vacrel->new_live_tuples, 0),
vacrel->recently_dead_tuples +
vacrel->missed_dead_tuples,
diff --git a/src/backend/postmaster/autovacuum.c b/src/backend/postmaster/autovacuum.c
index 1bd3924e35e..563a3697690 100644
--- a/src/backend/postmaster/autovacuum.c
+++ b/src/backend/postmaster/autovacuum.c
@@ -2048,8 +2048,7 @@ do_autovacuum(void)
/* Fetch reloptions and the pgstat entry for this table */
relopts = extract_autovac_opts(tuple, pg_class_desc);
- tabentry = pgstat_fetch_stat_tabentry_ext(classForm->relisshared,
- relid);
+ tabentry = pgstat_fetch_stat_tabentry_ext(relid);
/* Check if it needs vacuum or analyze */
relation_needs_vacanalyze(relid, relopts, classForm, tabentry,
@@ -2141,8 +2140,7 @@ do_autovacuum(void)
}
/* Fetch the pgstat entry for this table */
- tabentry = pgstat_fetch_stat_tabentry_ext(classForm->relisshared,
- relid);
+ tabentry = pgstat_fetch_stat_tabentry_ext(relid);
relation_needs_vacanalyze(relid, relopts, classForm, tabentry,
effective_multixact_freeze_max_age,
@@ -2939,8 +2937,7 @@ recheck_relation_needs_vacanalyze(Oid relid,
PgStat_StatTabEntry *tabentry;
/* fetch the pgstat table entry */
- tabentry = pgstat_fetch_stat_tabentry_ext(classForm->relisshared,
- relid);
+ tabentry = pgstat_fetch_stat_tabentry_ext(relid);
relation_needs_vacanalyze(relid, avopts, classForm, tabentry,
effective_multixact_freeze_max_age,
diff --git a/src/backend/utils/activity/pgstat_relation.c b/src/backend/utils/activity/pgstat_relation.c
index b90754f8578..ee6f2eb2bdb 100644
--- a/src/backend/utils/activity/pgstat_relation.c
+++ b/src/backend/utils/activity/pgstat_relation.c
@@ -17,12 +17,17 @@
#include "postgres.h"
+#include "access/htup_details.h"
#include "access/twophase_rmgr.h"
#include "access/xact.h"
#include "catalog/catalog.h"
+#include "catalog/pg_tablespace.h"
+#include "storage/lmgr.h"
#include "utils/memutils.h"
#include "utils/pgstat_internal.h"
#include "utils/rel.h"
+#include "utils/relmapper.h"
+#include "utils/syscache.h"
#include "utils/timestamp.h"
@@ -36,13 +41,12 @@ typedef struct TwoPhasePgStatRecord
PgStat_Counter inserted_pre_truncdrop;
PgStat_Counter updated_pre_truncdrop;
PgStat_Counter deleted_pre_truncdrop;
- Oid id; /* table's OID */
- bool shared; /* is it a shared catalog? */
+ RelFileLocator locator; /* table's rd_locator */
bool truncdropped; /* was the relation truncated/dropped? */
} TwoPhasePgStatRecord;
-static PgStat_TableStatus *pgstat_prep_relation_pending(Oid rel_id, bool isshared);
+static PgStat_TableStatus *pgstat_prep_relation_pending(RelFileLocator locator);
static void add_tabstat_xact_level(PgStat_TableStatus *pgstat_info, int nest_level);
static void ensure_tabstat_xact_level(PgStat_TableStatus *pgstat_info);
static void save_truncdrop_counters(PgStat_TableXactStatus *trans, bool is_drop);
@@ -60,8 +64,7 @@ pgstat_copy_relation_stats(Relation dst, Relation src)
PgStatShared_Relation *dstshstats;
PgStat_EntryRef *dst_ref;
- srcstats = pgstat_fetch_stat_tabentry_ext(src->rd_rel->relisshared,
- RelationGetRelid(src));
+ srcstats = pgstat_fetch_stat_tabentry_ext(RelationGetRelid(src));
if (!srcstats)
return;
@@ -94,8 +97,10 @@ pgstat_init_relation(Relation rel)
/*
* We only count stats for relations with storage and partitioned tables
+ * and we don't count stats generated during a rewrite.
*/
- if (!RELKIND_HAS_STORAGE(relkind) && relkind != RELKIND_PARTITIONED_TABLE)
+ if ((!RELKIND_HAS_STORAGE(relkind) && relkind != RELKIND_PARTITIONED_TABLE) ||
+ OidIsValid(rel->rd_rel->relrewrite))
{
rel->pgstat_enabled = false;
rel->pgstat_info = NULL;
@@ -130,12 +135,38 @@ pgstat_init_relation(Relation rel)
void
pgstat_assoc_relation(Relation rel)
{
+ RelFileLocator locator;
+
Assert(rel->pgstat_enabled);
Assert(rel->pgstat_info == NULL);
+ /*
+ * Don't associate stats for relations without storage and non partitioned
+ * tables.
+ */
+ if (!RELKIND_HAS_STORAGE(rel->rd_rel->relkind) &&
+ rel->rd_rel->relkind != RELKIND_PARTITIONED_TABLE)
+ return;
+
+ if (rel->rd_rel->relkind != RELKIND_PARTITIONED_TABLE)
+ locator = rel->rd_locator;
+ else
+ {
+ /*
+ * Partitioned tables don't have storage, so construct a synthetic
+ * locator for statistics tracking. Use the relation OID as relNumber.
+ * No collision with regular relations is possible because relNumbers
+ * are also assigned from the pg_class OID space (see
+ * GetNewRelFileNumber()), making each value unique across the
+ * database regardless of spcOid.
+ */
+ locator.dbOid = (rel->rd_rel->relisshared ? InvalidOid : MyDatabaseId);
+ locator.spcOid = InvalidOid;
+ locator.relNumber = rel->rd_id;
+ }
+
/* Else find or make the PgStat_TableStatus entry, and update link */
- rel->pgstat_info = pgstat_prep_relation_pending(RelationGetRelid(rel),
- rel->rd_rel->relisshared);
+ rel->pgstat_info = pgstat_prep_relation_pending(locator);
/* don't allow link a stats to multiple relcache entries */
Assert(rel->pgstat_info->relation == NULL);
@@ -167,9 +198,13 @@ pgstat_unlink_relation(Relation rel)
void
pgstat_create_relation(Relation rel)
{
+ /* don't track stats for relations without storage */
+ if (!RELKIND_HAS_STORAGE(rel->rd_rel->relkind))
+ return;
+
pgstat_create_transactional(PGSTAT_KIND_RELATION,
- rel->rd_rel->relisshared ? InvalidOid : MyDatabaseId,
- RelationGetRelid(rel));
+ rel->rd_locator.dbOid,
+ RelFileLocatorToPgStatObjid(rel->rd_locator));
}
/*
@@ -181,9 +216,13 @@ pgstat_drop_relation(Relation rel)
int nest_level = GetCurrentTransactionNestLevel();
PgStat_TableStatus *pgstat_info;
+ /* don't track stats for relations without storage */
+ if (!RELKIND_HAS_STORAGE(rel->rd_rel->relkind))
+ return;
+
pgstat_drop_transactional(PGSTAT_KIND_RELATION,
- rel->rd_rel->relisshared ? InvalidOid : MyDatabaseId,
- RelationGetRelid(rel));
+ rel->rd_locator.dbOid,
+ RelFileLocatorToPgStatObjid(rel->rd_locator));
if (!pgstat_should_count_relation(rel))
return;
@@ -207,14 +246,12 @@ pgstat_drop_relation(Relation rel)
* Report that the table was just vacuumed and flush IO statistics.
*/
void
-pgstat_report_vacuum(Oid tableoid, bool shared,
- PgStat_Counter livetuples, PgStat_Counter deadtuples,
- TimestampTz starttime)
+pgstat_report_vacuum(RelFileLocator locator, PgStat_Counter livetuples,
+ PgStat_Counter deadtuples, TimestampTz starttime)
{
PgStat_EntryRef *entry_ref;
PgStatShared_Relation *shtabentry;
PgStat_StatTabEntry *tabentry;
- Oid dboid = (shared ? InvalidOid : MyDatabaseId);
TimestampTz ts;
PgStat_Counter elapsedtime;
@@ -227,7 +264,7 @@ pgstat_report_vacuum(Oid tableoid, bool shared,
/* block acquiring lock for the same reason as pgstat_report_autovac() */
entry_ref = pgstat_get_entry_ref_locked(PGSTAT_KIND_RELATION,
- dboid, tableoid, false);
+ locator.dbOid, RelFileLocatorToPgStatObjid(locator), false);
shtabentry = (PgStatShared_Relation *) entry_ref->shared_stats;
tabentry = &shtabentry->stats;
@@ -286,9 +323,9 @@ pgstat_report_analyze(Relation rel,
PgStat_EntryRef *entry_ref;
PgStatShared_Relation *shtabentry;
PgStat_StatTabEntry *tabentry;
- Oid dboid = (rel->rd_rel->relisshared ? InvalidOid : MyDatabaseId);
TimestampTz ts;
PgStat_Counter elapsedtime;
+ RelFileLocator locator;
if (!pgstat_track_counts)
return;
@@ -326,9 +363,26 @@ pgstat_report_analyze(Relation rel,
ts = GetCurrentTimestamp();
elapsedtime = TimestampDifferenceMilliseconds(starttime, ts);
+ if (rel->rd_rel->relkind != RELKIND_PARTITIONED_TABLE)
+ locator = rel->rd_locator;
+ else
+ {
+ /*
+ * Partitioned tables don't have storage, so construct a synthetic
+ * locator for statistics tracking. Use the relation OID as relNumber.
+ * No collision with regular relations is possible because relNumbers
+ * are also assigned from the pg_class OID space (see
+ * GetNewRelFileNumber()), making each value unique across the
+ * database regardless of spcOid.
+ */
+ locator.dbOid = (rel->rd_rel->relisshared ? InvalidOid : MyDatabaseId);
+ locator.spcOid = InvalidOid;
+ locator.relNumber = rel->rd_id;
+ }
/* block acquiring lock for the same reason as pgstat_report_autovac() */
- entry_ref = pgstat_get_entry_ref_locked(PGSTAT_KIND_RELATION, dboid,
- RelationGetRelid(rel),
+ entry_ref = pgstat_get_entry_ref_locked(PGSTAT_KIND_RELATION,
+ locator.dbOid,
+ RelFileLocatorToPgStatObjid(locator),
false);
/* can't get dropped while accessed */
Assert(entry_ref != NULL && entry_ref->shared_stats != NULL);
@@ -469,7 +523,7 @@ pgstat_update_heap_dead_tuples(Relation rel, int delta)
PgStat_StatTabEntry *
pgstat_fetch_stat_tabentry(Oid relid)
{
- return pgstat_fetch_stat_tabentry_ext(IsSharedRelation(relid), relid);
+ return pgstat_fetch_stat_tabentry_ext(relid);
}
/*
@@ -477,12 +531,19 @@ pgstat_fetch_stat_tabentry(Oid relid)
* whether the to-be-accessed table is a shared relation or not.
*/
PgStat_StatTabEntry *
-pgstat_fetch_stat_tabentry_ext(bool shared, Oid reloid)
+pgstat_fetch_stat_tabentry_ext(Oid reloid)
{
- Oid dboid = (shared ? InvalidOid : MyDatabaseId);
+ PgStat_StatTabEntry *tabentry;
+ RelFileLocator locator;
+
+ if (!pgstat_reloid_to_relfilelocator(reloid, &locator))
+ return NULL;
- return (PgStat_StatTabEntry *)
- pgstat_fetch_entry(PGSTAT_KIND_RELATION, dboid, reloid);
+ /* fetch the stats entry using the relfilenode based key */
+ tabentry = (PgStat_StatTabEntry *) pgstat_fetch_entry(PGSTAT_KIND_RELATION,
+ locator.dbOid,
+ RelFileLocatorToPgStatObjid(locator));
+ return tabentry;
}
/*
@@ -504,14 +565,17 @@ find_tabstat_entry(Oid rel_id)
PgStat_TableXactStatus *trans;
PgStat_TableStatus *tabentry = NULL;
PgStat_TableStatus *tablestatus = NULL;
+ RelFileLocator locator;
+
+ if (!pgstat_reloid_to_relfilelocator(rel_id, &locator))
+ return NULL;
+
+ entry_ref = pgstat_fetch_pending_entry(PGSTAT_KIND_RELATION,
+ locator.dbOid,
+ RelFileLocatorToPgStatObjid(locator));
- entry_ref = pgstat_fetch_pending_entry(PGSTAT_KIND_RELATION, MyDatabaseId, rel_id);
if (!entry_ref)
- {
- entry_ref = pgstat_fetch_pending_entry(PGSTAT_KIND_RELATION, InvalidOid, rel_id);
- if (!entry_ref)
- return tablestatus;
- }
+ return tablestatus;
tabentry = (PgStat_TableStatus *) entry_ref->pending;
tablestatus = palloc_object(PgStat_TableStatus);
@@ -707,8 +771,12 @@ AtPrepare_PgStat_Relations(PgStat_SubXactStatus *xact_state)
record.inserted_pre_truncdrop = trans->inserted_pre_truncdrop;
record.updated_pre_truncdrop = trans->updated_pre_truncdrop;
record.deleted_pre_truncdrop = trans->deleted_pre_truncdrop;
- record.id = tabstat->id;
- record.shared = tabstat->shared;
+
+ if (tabstat->relation != NULL)
+ record.locator = tabstat->relation->rd_locator;
+ else
+ record.locator = tabstat->locator;
+
record.truncdropped = trans->truncdropped;
RegisterTwoPhaseRecord(TWOPHASE_RM_PGSTAT_ID, 0,
@@ -751,7 +819,7 @@ pgstat_twophase_postcommit(FullTransactionId fxid, uint16 info,
PgStat_TableStatus *pgstat_info;
/* Find or create a tabstat entry for the rel */
- pgstat_info = pgstat_prep_relation_pending(rec->id, rec->shared);
+ pgstat_info = pgstat_prep_relation_pending(rec->locator);
/* Same math as in AtEOXact_PgStat, commit case */
pgstat_info->counts.tuples_inserted += rec->tuples_inserted;
@@ -786,8 +854,8 @@ pgstat_twophase_postabort(FullTransactionId fxid, uint16 info,
TwoPhasePgStatRecord *rec = (TwoPhasePgStatRecord *) recdata;
PgStat_TableStatus *pgstat_info;
- /* Find or create a tabstat entry for the rel */
- pgstat_info = pgstat_prep_relation_pending(rec->id, rec->shared);
+ /* Find or create a tabstat entry for the target locator */
+ pgstat_info = pgstat_prep_relation_pending(rec->locator);
/* Same math as in AtEOXact_PgStat, abort case */
if (rec->truncdropped)
@@ -921,17 +989,21 @@ pgstat_relation_reset_timestamp_cb(PgStatShared_Common *header, TimestampTz ts)
* initialized if not exists.
*/
static PgStat_TableStatus *
-pgstat_prep_relation_pending(Oid rel_id, bool isshared)
+pgstat_prep_relation_pending(RelFileLocator locator)
{
PgStat_EntryRef *entry_ref;
PgStat_TableStatus *pending;
+ uint64 objid;
+
+ objid = RelFileLocatorToPgStatObjid(locator);
entry_ref = pgstat_prep_pending_entry(PGSTAT_KIND_RELATION,
- isshared ? InvalidOid : MyDatabaseId,
- rel_id, NULL);
+ locator.dbOid,
+ objid, NULL);
+
pending = entry_ref->pending;
- pending->id = rel_id;
- pending->shared = isshared;
+ pending->id = objid;
+ pending->locator = locator;
return pending;
}
@@ -1010,3 +1082,83 @@ restore_truncdrop_counters(PgStat_TableXactStatus *trans)
trans->tuples_deleted = trans->deleted_pre_truncdrop;
}
}
+
+/*
+ * Convert a relation OID to its corresponding RelFileLocator for statistics
+ * tracking purposes.
+ *
+ * Returns true on success, false if the relation doesn't need statistics
+ * tracking.
+ *
+ * For partitioned tables, constructs a synthetic locator using the relation
+ * OID as relNumber, since they don't have storage.
+ */
+bool
+pgstat_reloid_to_relfilelocator(Oid reloid, RelFileLocator *locator)
+{
+ HeapTuple tuple;
+ Form_pg_class relform;
+ bool result = true;
+
+ /* get the relation's tuple from pg_class */
+ tuple = SearchSysCache1(RELOID, ObjectIdGetDatum(reloid));
+
+ if (!HeapTupleIsValid(tuple))
+ return false;
+
+ relform = (Form_pg_class) GETSTRUCT(tuple);
+
+ /* skip relations without storage and non partitioned tables */
+ if (!RELKIND_HAS_STORAGE(relform->relkind) &&
+ relform->relkind != RELKIND_PARTITIONED_TABLE)
+ {
+ ReleaseSysCache(tuple);
+ return false;
+ }
+
+ if (relform->relkind != RELKIND_PARTITIONED_TABLE)
+ {
+ /* build the RelFileLocator */
+ locator->relNumber = relform->relfilenode;
+ locator->spcOid = relform->reltablespace;
+
+ /* handle default tablespace */
+ if (!OidIsValid(locator->spcOid))
+ locator->spcOid = MyDatabaseTableSpace;
+
+ /* handle dbOid for global vs local relations */
+ if (locator->spcOid == GLOBALTABLESPACE_OID)
+ locator->dbOid = InvalidOid;
+ else
+ locator->dbOid = MyDatabaseId;
+
+ /* handle mapped relations */
+ if (!RelFileNumberIsValid(locator->relNumber))
+ {
+ locator->relNumber = RelationMapOidToFilenumber(reloid,
+ relform->relisshared);
+ if (!RelFileNumberIsValid(locator->relNumber))
+ {
+ ReleaseSysCache(tuple);
+ return false;
+ }
+ }
+ }
+ else
+ {
+ /*
+ * Partitioned tables don't have storage, so construct a synthetic
+ * locator for statistics tracking. Use the relation OID as relNumber.
+ * No collision with regular relations is possible because relNumbers
+ * are also assigned from the pg_class OID space (see
+ * GetNewRelFileNumber()), making each value unique across the
+ * database regardless of spcOid.
+ */
+ locator->dbOid = (relform->relisshared ? InvalidOid : MyDatabaseId);
+ locator->spcOid = InvalidOid;
+ locator->relNumber = relform->oid;
+ }
+
+ ReleaseSysCache(tuple);
+ return result;
+}
diff --git a/src/backend/utils/adt/pgstatfuncs.c b/src/backend/utils/adt/pgstatfuncs.c
index ef6fffe60b9..60ffb1679ec 100644
--- a/src/backend/utils/adt/pgstatfuncs.c
+++ b/src/backend/utils/adt/pgstatfuncs.c
@@ -23,13 +23,13 @@
#include "common/ip.h"
#include "funcapi.h"
#include "miscadmin.h"
-#include "pgstat.h"
#include "postmaster/bgworker.h"
#include "replication/logicallauncher.h"
#include "storage/proc.h"
#include "storage/procarray.h"
#include "utils/acl.h"
#include "utils/builtins.h"
+#include "utils/pgstat_internal.h"
#include "utils/timestamp.h"
#define UINT32_ACCESS_ONCE(var) ((uint32)(*((volatile uint32 *)&(var))))
@@ -1949,9 +1949,14 @@ Datum
pg_stat_reset_single_table_counters(PG_FUNCTION_ARGS)
{
Oid taboid = PG_GETARG_OID(0);
- Oid dboid = (IsSharedRelation(taboid) ? InvalidOid : MyDatabaseId);
+ RelFileLocator locator;
- pgstat_reset(PGSTAT_KIND_RELATION, dboid, taboid);
+ /* Get the stats locator from the relation OID */
+ if (!pgstat_reloid_to_relfilelocator(taboid, &locator))
+ PG_RETURN_VOID();
+
+ pgstat_reset(PGSTAT_KIND_RELATION, locator.dbOid,
+ RelFileLocatorToPgStatObjid(locator));
PG_RETURN_VOID();
}
@@ -2305,5 +2310,16 @@ pg_stat_have_stats(PG_FUNCTION_ARGS)
uint64 objid = PG_GETARG_INT64(2);
PgStat_Kind kind = pgstat_get_kind_from_str(stats_type);
+ /* Convert relation OID to relfilenode objid */
+ if (kind == PGSTAT_KIND_RELATION)
+ {
+ RelFileLocator locator;
+
+ if (!pgstat_reloid_to_relfilelocator(objid, &locator))
+ PG_RETURN_BOOL(false);
+
+ objid = RelFileLocatorToPgStatObjid(locator);
+ }
+
PG_RETURN_BOOL(pgstat_have_entry(kind, dboid, objid));
}
diff --git a/src/include/pgstat.h b/src/include/pgstat.h
index f23dd5870da..c9e451094f3 100644
--- a/src/include/pgstat.h
+++ b/src/include/pgstat.h
@@ -17,6 +17,7 @@
#include "postmaster/pgarch.h" /* for MAX_XFN_CHARS */
#include "replication/conflict.h"
#include "replication/worker_internal.h"
+#include "storage/relfilelocator.h"
#include "utils/backend_progress.h" /* for backward compatibility */ /* IWYU pragma: export */
#include "utils/backend_status.h" /* for backward compatibility */ /* IWYU pragma: export */
#include "utils/pgstat_kind.h"
@@ -35,6 +36,12 @@
/* Default directory to store temporary statistics data in */
#define PG_STAT_TMP_DIR "pg_stat_tmp"
+/*
+ * Build a pgstat key Objid based on a RelFileLocator.
+ */
+#define RelFileLocatorToPgStatObjid(locator) \
+ (((uint64) (locator).spcOid << 32) | (locator).relNumber)
+
/* Values for track_functions GUC variable --- order is significant! */
typedef enum TrackFunctionsLevel
{
@@ -175,11 +182,11 @@ typedef struct PgStat_TableCounts
*/
typedef struct PgStat_TableStatus
{
- Oid id; /* table's OID */
- bool shared; /* is it a shared catalog? */
+ uint64 id; /* hash of relfilelocator for stats key */
struct PgStat_TableXactStatus *trans; /* lowest subxact's counts */
PgStat_TableCounts counts; /* event counts to be sent */
Relation relation; /* rel that is using this entry */
+ RelFileLocator locator; /* table's relfilelocator */
} PgStat_TableStatus;
/* ----------
@@ -669,8 +676,8 @@ extern void pgstat_init_relation(Relation rel);
extern void pgstat_assoc_relation(Relation rel);
extern void pgstat_unlink_relation(Relation rel);
-extern void pgstat_report_vacuum(Oid tableoid, bool shared,
- PgStat_Counter livetuples, PgStat_Counter deadtuples,
+extern void pgstat_report_vacuum(RelFileLocator locator, PgStat_Counter livetuples,
+ PgStat_Counter deadtuples,
TimestampTz starttime);
extern void pgstat_report_analyze(Relation rel,
PgStat_Counter livetuples, PgStat_Counter deadtuples,
@@ -735,8 +742,7 @@ extern void pgstat_twophase_postabort(FullTransactionId fxid, uint16 info,
void *recdata, uint32 len);
extern PgStat_StatTabEntry *pgstat_fetch_stat_tabentry(Oid relid);
-extern PgStat_StatTabEntry *pgstat_fetch_stat_tabentry_ext(bool shared,
- Oid reloid);
+extern PgStat_StatTabEntry *pgstat_fetch_stat_tabentry_ext(Oid reloid);
extern PgStat_TableStatus *find_tabstat_entry(Oid rel_id);
diff --git a/src/include/utils/pgstat_internal.h b/src/include/utils/pgstat_internal.h
index 5c1ce4d3d6a..7b24928b00d 100644
--- a/src/include/utils/pgstat_internal.h
+++ b/src/include/utils/pgstat_internal.h
@@ -764,6 +764,7 @@ extern void PostPrepare_PgStat_Relations(PgStat_SubXactStatus *xact_state);
extern bool pgstat_relation_flush_cb(PgStat_EntryRef *entry_ref, bool nowait);
extern void pgstat_relation_delete_pending_cb(PgStat_EntryRef *entry_ref);
extern void pgstat_relation_reset_timestamp_cb(PgStatShared_Common *header, TimestampTz ts);
+extern bool pgstat_reloid_to_relfilelocator(Oid reloid, RelFileLocator *locator);
/*
diff --git a/src/test/recovery/t/029_stats_restart.pl b/src/test/recovery/t/029_stats_restart.pl
index 021e2bf361f..3a9c05eaf10 100644
--- a/src/test/recovery/t/029_stats_restart.pl
+++ b/src/test/recovery/t/029_stats_restart.pl
@@ -55,10 +55,10 @@ trigger_funcrel_stat();
# verify stats objects exist
$sect = "initial";
-is(have_stats('database', $dboid, 0), 't', "$sect: db stats do exist");
-is(have_stats('function', $dboid, $funcoid),
+is(have_stats($connect_db, 'database', $dboid, 0), 't', "$sect: db stats do exist");
+is(have_stats($db_under_test, 'function', $dboid, $funcoid),
't', "$sect: function stats do exist");
-is(have_stats('relation', $dboid, $tableoid),
+is(have_stats($db_under_test, 'relation', $dboid, $tableoid),
't', "$sect: relation stats do exist");
# regular shutdown
@@ -79,10 +79,10 @@ copy($og_stats, $statsfile) or die "Copy failed: $!";
$node->start;
$sect = "copy";
-is(have_stats('database', $dboid, 0), 't', "$sect: db stats do exist");
-is(have_stats('function', $dboid, $funcoid),
+is(have_stats($connect_db, 'database', $dboid, 0), 't', "$sect: db stats do exist");
+is(have_stats($db_under_test, 'function', $dboid, $funcoid),
't', "$sect: function stats do exist");
-is(have_stats('relation', $dboid, $tableoid),
+is(have_stats($db_under_test, 'relation', $dboid, $tableoid),
't', "$sect: relation stats do exist");
$node->stop('immediate');
@@ -96,10 +96,10 @@ $node->start;
# stats should have been discarded
$sect = "post immediate";
-is(have_stats('database', $dboid, 0), 'f', "$sect: db stats do not exist");
-is(have_stats('function', $dboid, $funcoid),
+is(have_stats($connect_db, 'database', $dboid, 0), 'f', "$sect: db stats do not exist");
+is(have_stats($db_under_test, 'function', $dboid, $funcoid),
'f', "$sect: function stats do exist");
-is(have_stats('relation', $dboid, $tableoid),
+is(have_stats($db_under_test, 'relation', $dboid, $tableoid),
'f', "$sect: relation stats do not exist");
# get rid of backup statsfile
@@ -110,10 +110,10 @@ unlink $statsfile or die "cannot unlink $statsfile $!";
trigger_funcrel_stat();
$sect = "post immediate, new";
-is(have_stats('database', $dboid, 0), 't', "$sect: db stats do exist");
-is(have_stats('function', $dboid, $funcoid),
+is(have_stats($connect_db, 'database', $dboid, 0), 't', "$sect: db stats do exist");
+is(have_stats($db_under_test, 'function', $dboid, $funcoid),
't', "$sect: function stats do exist");
-is(have_stats('relation', $dboid, $tableoid),
+is(have_stats($db_under_test, 'relation', $dboid, $tableoid),
't', "$sect: relation stats do exist");
# regular shutdown
@@ -129,10 +129,10 @@ $node->start;
# no stats present due to invalid stats file
$sect = "invalid_overwrite";
-is(have_stats('database', $dboid, 0), 'f', "$sect: db stats do not exist");
-is(have_stats('function', $dboid, $funcoid),
+is(have_stats($connect_db, 'database', $dboid, 0), 'f', "$sect: db stats do not exist");
+is(have_stats($db_under_test, 'function', $dboid, $funcoid),
'f', "$sect: function stats do not exist");
-is(have_stats('relation', $dboid, $tableoid),
+is(have_stats($db_under_test, 'relation', $dboid, $tableoid),
'f', "$sect: relation stats do not exist");
@@ -145,10 +145,10 @@ append_file($og_stats, "XYZ");
$node->start;
$sect = "invalid_append";
-is(have_stats('database', $dboid, 0), 'f', "$sect: db stats do not exist");
-is(have_stats('function', $dboid, $funcoid),
+is(have_stats($connect_db, 'database', $dboid, 0), 'f', "$sect: db stats do not exist");
+is(have_stats($db_under_test, 'function', $dboid, $funcoid),
'f', "$sect: function stats do not exist");
-is(have_stats('relation', $dboid, $tableoid),
+is(have_stats($db_under_test, 'relation', $dboid, $tableoid),
'f', "$sect: relation stats do not exist");
@@ -307,9 +307,9 @@ sub trigger_funcrel_stat
sub have_stats
{
- my ($kind, $dboid, $objid) = @_;
+ my ($db, $kind, $dboid, $objid) = @_;
- return $node->safe_psql($connect_db,
+ return $node->safe_psql($db,
"SELECT pg_stat_have_stats('$kind', $dboid, $objid)");
}
--
2.34.1
--BHD/2LBqtxMXWADJ
Content-Type: text/x-diff; charset=us-ascii
Content-Disposition: attachment;
filename="v8-0002-handle-relation-statistics-correctly-during-rewri.patch"
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v1] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 ++--
src/backend/commands/prepare.c | 43 +++++++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++++++---------
src/test/regress/sql/prepare.sql | 2 +-
4 files changed, 72 insertions(+), 25 deletions(-)
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 6af5ac1da18..535c4770095 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 34b6410d6a2..11b330ab73d 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--biRhQYMBrGQlqcCN--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v2] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 2 +-
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 27 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index fe0478ac552..9a6bda90070 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -21,7 +21,7 @@ LDFLAGS_SL += $(filter -lm, $(LIBS))
REGRESS_OPTS = --temp-config $(top_srcdir)/contrib/pg_stat_statements/pg_stat_statements.conf
REGRESS = select dml cursors utility level_tracking planning \
user_activity wal entry_timestamp privileges extended \
- parallel plancache cleanup oldextversions squashing
+ parallel plancache cleanup oldextversions squashing prepare
# Disabled because these tests require "shared_preload_libraries=pg_stat_statements",
# which typical installcheck users do not have (e.g. buildfarm clients).
NO_INSTALLCHECK = 1
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 079a8eb5afc..65258651bd2 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -59,6 +59,7 @@ tests += {
'cleanup',
'oldextversions',
'squashing',
+ 'prepare',
],
'regress_args': ['--temp-config', files('pg_stat_statements.conf')],
# Disabled because these tests require
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--soawQPnav6xcFtRL--
^ permalink raw reply [nested|flat] 223+ messages in thread
* [PATCH v3] Cleanup explicit PREPARE query strings
@ 2025-12-24 14:31 Julien Rouhaud <[email protected]>
0 siblings, 0 replies; 223+ messages in thread
From: Julien Rouhaud @ 2025-12-24 14:31 UTC (permalink / raw)
When a multi statements query string contains one PREPARE statement (or
multiple), the whole query string was saved in the cached plan. This is
wasteful as that string can be artitrarily big, but it can also confusing as
some other parts like pg_prepared_statements will output the saved query string
as-is.
This commit changes this behavior and only stores the part of the query string
that correspond to any given PREPARED statement, similarly to how it's already
done in pg_stat_statements.
---
contrib/auto_explain/t/001_auto_explain.pl | 8 +--
contrib/pg_stat_statements/Makefile | 1 +
.../pg_stat_statements/expected/prepare.out | 53 +++++++++++++++++++
contrib/pg_stat_statements/meson.build | 1 +
contrib/pg_stat_statements/sql/prepare.sql | 15 ++++++
src/backend/commands/prepare.c | 45 ++++++++++++++--
src/test/regress/expected/prepare.out | 44 +++++++++------
src/test/regress/sql/prepare.sql | 2 +-
8 files changed, 143 insertions(+), 26 deletions(-)
create mode 100644 contrib/pg_stat_statements/expected/prepare.out
create mode 100644 contrib/pg_stat_statements/sql/prepare.sql
diff --git a/contrib/auto_explain/t/001_auto_explain.pl b/contrib/auto_explain/t/001_auto_explain.pl
index 5f673bd14c1..f2d8625f8bb 100644
--- a/contrib/auto_explain/t/001_auto_explain.pl
+++ b/contrib/auto_explain/t/001_auto_explain.pl
@@ -60,7 +60,7 @@ $log_contents = query_log($node,
like(
$log_contents,
- qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1;/,
+ qr/Query Text: PREPARE get_proc\(name\) AS SELECT \* FROM pg_proc WHERE proname = \$1/,
"prepared query text logged, text mode");
like(
@@ -82,7 +82,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
like(
@@ -98,7 +98,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1;/,
+ qr/Query Text: PREPARE get_type\(name\) AS SELECT \* FROM pg_type WHERE typname = \$1/,
"prepared query text logged, text mode");
unlike(
@@ -164,7 +164,7 @@ $log_contents = query_log(
like(
$log_contents,
- qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1;"/,
+ qr/"Query Text": "PREPARE get_class\(name\) AS SELECT \* FROM pg_class WHERE relname = \$1"/,
"prepared query text logged, json mode");
like(
diff --git a/contrib/pg_stat_statements/Makefile b/contrib/pg_stat_statements/Makefile
index c27e9529bb6..ac967687796 100644
--- a/contrib/pg_stat_statements/Makefile
+++ b/contrib/pg_stat_statements/Makefile
@@ -36,6 +36,7 @@ REGRESS = \
parallel \
plancache \
squashing \
+ prepare \
cleanup \
oldextversions
diff --git a/contrib/pg_stat_statements/expected/prepare.out b/contrib/pg_stat_statements/expected/prepare.out
new file mode 100644
index 00000000000..010e289c1b0
--- /dev/null
+++ b/contrib/pg_stat_statements/expected/prepare.out
@@ -0,0 +1,53 @@
+-- Tests for PREPARE
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+ ?column?
+----------
+ 1
+(1 row)
+
+ ?column? | ?column?
+----------+----------
+ 1 | 1
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | SELECT $1
+ 1 | 1 | SELECT $1, $2
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+ t
+---
+ t
+(1 row)
+
+EXECUTE p1;
+ ?column?
+----------
+ 1
+(1 row)
+
+EXECUTE p2(0);
+ ?column?
+----------
+ 0
+(1 row)
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+ calls | rows | query
+-------+------+----------------------------------------------------
+ 1 | 1 | PREPARE p1 AS SELECT 1
+ 1 | 1 | PREPARE p2(int) AS SELECT 2 * $1
+ 1 | 1 | SELECT pg_stat_statements_reset() IS NOT NULL AS t
+(3 rows)
+
diff --git a/contrib/pg_stat_statements/meson.build b/contrib/pg_stat_statements/meson.build
index 9d78cb88b7d..c9e1d446d39 100644
--- a/contrib/pg_stat_statements/meson.build
+++ b/contrib/pg_stat_statements/meson.build
@@ -58,6 +58,7 @@ tests += {
'parallel',
'plancache',
'squashing',
+ 'prepare',
'cleanup',
'oldextversions',
],
diff --git a/contrib/pg_stat_statements/sql/prepare.sql b/contrib/pg_stat_statements/sql/prepare.sql
new file mode 100644
index 00000000000..a6bc5de4430
--- /dev/null
+++ b/contrib/pg_stat_statements/sql/prepare.sql
@@ -0,0 +1,15 @@
+-- Tests for PREPARE
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+-- Test that prepared statements in a multi-query string behaves as expected
+SELECT 1\;PREPARE p1 AS SELECT 1\; PREPARE p2(int) AS SELECT 2 * $1\; SELECT 1, 1;
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
+
+SELECT pg_stat_statements_reset() IS NOT NULL AS t;
+
+EXECUTE p1;
+EXECUTE p2(0);
+
+SELECT calls, rows, query FROM pg_stat_statements ORDER BY query COLLATE "C";
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
index 5b86a727587..b8fe3dd5302 100644
--- a/src/backend/commands/prepare.c
+++ b/src/backend/commands/prepare.c
@@ -27,6 +27,7 @@
#include "commands/prepare.h"
#include "funcapi.h"
#include "nodes/nodeFuncs.h"
+#include "nodes/queryjumble.h"
#include "parser/parse_coerce.h"
#include "parser/parse_collate.h"
#include "parser/parse_expr.h"
@@ -64,6 +65,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
Oid *argtypes = NULL;
int nargs;
List *query_list;
+ const char *new_query;
/*
* Disallow empty-string statement name (conflicts with protocol-level
@@ -80,14 +82,49 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
*/
rawstmt = makeNode(RawStmt);
rawstmt->stmt = stmt->query;
- rawstmt->stmt_location = stmt_location;
- rawstmt->stmt_len = stmt_len;
+
+ /*
+ * Extract the query text if possible.
+ *
+ * If we have a statement location, we can extract the relevant part of the
+ * possibly multi-statement query string. If not just use what we were
+ * given.
+ */
+ if (stmt_location < 0)
+ {
+ rawstmt->stmt_location = stmt_location;
+ rawstmt->stmt_len = stmt_len;
+ new_query = pstate->p_sourcetext;
+ }
+ else
+ {
+ const char *cleaned;
+ char *tmp;
+
+ rawstmt->stmt_len = stmt_len;
+ cleaned = CleanQuerytext(pstate->p_sourcetext, &stmt_location,
+ &rawstmt->stmt_len);
+
+ if (rawstmt->stmt_len == 0)
+ rawstmt->stmt_len = strlen(cleaned);
+
+ /*
+ * CleanQuerytext() removes any leading whitespace and returns a
+ * pointer to the first actual character, so the cleaned query string
+ * is guaranteed to start at offset 0.
+ */
+ rawstmt->stmt_location = 0;
+ tmp = palloc(rawstmt->stmt_len + 1);
+ strlcpy(tmp, cleaned, rawstmt->stmt_len + 1);
+
+ new_query = tmp;
+ }
/*
* Create the CachedPlanSource before we do parse analysis, since it needs
* to see the unmodified raw parse tree.
*/
- plansource = CreateCachedPlan(rawstmt, pstate->p_sourcetext,
+ plansource = CreateCachedPlan(rawstmt, new_query,
CreateCommandTag(stmt->query));
/* Transform list of TypeNames to array of type OIDs */
@@ -116,7 +153,7 @@ PrepareQuery(ParseState *pstate, PrepareStmt *stmt,
* information about unknown parameters to be deduced from context.
* Rewrite the query. The result could be 0, 1, or many queries.
*/
- query_list = pg_analyze_and_rewrite_varparams(rawstmt, pstate->p_sourcetext,
+ query_list = pg_analyze_and_rewrite_varparams(rawstmt, new_query,
&argtypes, &nargs, NULL);
/* Finish filling in the CachedPlanSource */
diff --git a/src/test/regress/expected/prepare.out b/src/test/regress/expected/prepare.out
index 5815e17b39c..c645a4e5d0e 100644
--- a/src/test/regress/expected/prepare.out
+++ b/src/test/regress/expected/prepare.out
@@ -6,7 +6,17 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+-----------+-----------------+--------------
(0 rows)
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
+ ?column?
+----------
+ bingo
+(1 row)
+
+ ?column?
+----------
+ 42
+(1 row)
+
EXECUTE q1;
a
---
@@ -14,9 +24,9 @@ EXECUTE q1;
(1 row)
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 1 AS a; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 1 AS a | {} | {integer}
(1 row)
-- should fail
@@ -33,18 +43,18 @@ EXECUTE q1;
PREPARE q2 AS SELECT 2 AS b;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q1 | PREPARE q1 AS SELECT 2; | {} | {integer}
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q1 | PREPARE q1 AS SELECT 2 | {} | {integer}
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(2 rows)
-- sql92 syntax
DEALLOCATE PREPARE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
- name | statement | parameter_types | result_types
-------+------------------------------+-----------------+--------------
- q2 | PREPARE q2 AS SELECT 2 AS b; | {} | {integer}
+ name | statement | parameter_types | result_types
+------+-----------------------------+-----------------+--------------
+ q2 | PREPARE q2 AS SELECT 2 AS b | {} | {integer}
(1 row)
DEALLOCATE PREPARE q2;
@@ -168,20 +178,20 @@ SELECT name, statement, parameter_types, result_types FROM pg_prepared_statement
------+------------------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------
q2 | PREPARE q2(text) AS +| {text} | {name,boolean,boolean}
| SELECT datname, datistemplate, datallowconn +| |
- | FROM pg_database WHERE datname = $1; | |
+ | FROM pg_database WHERE datname = $1 | |
q3 | PREPARE q3(text, int, float, boolean, smallint) AS +| {text,integer,"double precision",boolean,smallint} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE string4 = $1 AND (four = $2 OR+| |
| ten = $3::bigint OR true = $4 OR odd = $5::int) +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q5 | PREPARE q5(int, text) AS +| {integer,text} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
| SELECT * FROM tenk1 WHERE unique1 = $1 OR stringu1 = $2 +| |
- | ORDER BY unique1; | |
+ | ORDER BY unique1 | |
q6 | PREPARE q6 AS +| {integer,name} | {integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,integer,name,name,name}
- | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2; | |
+ | SELECT * FROM tenk1 WHERE unique1 = $1 AND stringu1 = $2 | |
q7 | PREPARE q7(unknown) AS +| {path} | {text,path}
- | SELECT * FROM road WHERE thepath = $1; | |
+ | SELECT * FROM road WHERE thepath = $1 | |
q8 | PREPARE q8 AS +| {integer,name} |
- | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1; | |
+ | UPDATE tenk1 SET stringu1 = $2 WHERE unique1 = $1 | |
(6 rows)
-- test DEALLOCATE ALL;
diff --git a/src/test/regress/sql/prepare.sql b/src/test/regress/sql/prepare.sql
index c6098dc95ce..0e7fe44725e 100644
--- a/src/test/regress/sql/prepare.sql
+++ b/src/test/regress/sql/prepare.sql
@@ -4,7 +4,7 @@
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
-PREPARE q1 AS SELECT 1 AS a;
+SELECT 'bingo'\; PREPARE q1 AS SELECT 1 AS a \; SELECT 42;
EXECUTE q1;
SELECT name, statement, parameter_types, result_types FROM pg_prepared_statements;
--
2.52.0
--xBRJzsblsXcilRYX--
^ permalink raw reply [nested|flat] 223+ messages in thread
end of thread, other threads:[~2025-12-24 14:31 UTC | newest]
Thread overview: 223+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2025-10-01 09:45 [PATCH v8 1/2] Key PGSTAT_KIND_RELATION by relfile locator Bertrand Drouvot <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v1] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v2] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
2025-12-24 14:31 [PATCH v3] Cleanup explicit PREPARE query strings Julien Rouhaud <[email protected]>
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox