]> begriffs open source - ai-pg/blob - full-docs/src/sgml/html/view-pg-prepared-statements.html
PG 18 docs from https://ftp.postgresql.org/pub/source/v18.0/postgresql-18.0-docs...
[ai-pg] / full-docs / src / sgml / html / view-pg-prepared-statements.html
1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>53.16. pg_prepared_statements</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="pgsql-docs@lists.postgresql.org" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="prev" href="view-pg-policies.html" title="53.15. pg_policies" /><link rel="next" href="view-pg-prepared-xacts.html" title="53.17. pg_prepared_xacts" /></head><body id="docContent" class="container-fluid col-10"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">53.16. <code class="structname">pg_prepared_statements</code></th></tr><tr><td width="10%" align="left"><a accesskey="p" href="view-pg-policies.html" title="53.15. pg_policies">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="views.html" title="Chapter 53. System Views">Up</a></td><th width="60%" align="center">Chapter 53. System Views</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 18.0 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="view-pg-prepared-xacts.html" title="53.17. pg_prepared_xacts">Next</a></td></tr></table><hr /></div><div class="sect1" id="VIEW-PG-PREPARED-STATEMENTS"><div class="titlepage"><div><div><h2 class="title" style="clear: both">53.16. <code class="structname">pg_prepared_statements</code> <a href="#VIEW-PG-PREPARED-STATEMENTS" class="id_link">#</a></h2></div></div></div><a id="id-1.10.5.20.2" class="indexterm"></a><p>
3    The <code class="structname">pg_prepared_statements</code> view displays
4    all the prepared statements that are available in the current
5    session. See <a class="xref" href="sql-prepare.html" title="PREPARE"><span class="refentrytitle">PREPARE</span></a> for more information about prepared
6    statements.
7   </p><p>
8    <code class="structname">pg_prepared_statements</code> contains one row
9    for each prepared statement. Rows are added to the view when a new
10    prepared statement is created and removed when a prepared statement
11    is released (for example, via the <a class="link" href="sql-deallocate.html" title="DEALLOCATE"><code class="command">DEALLOCATE</code></a> command).
12   </p><div class="table" id="id-1.10.5.20.5"><p class="title"><strong>Table 53.16. <code class="structname">pg_prepared_statements</code> Columns</strong></p><div class="table-contents"><table class="table" summary="pg_prepared_statements Columns" border="1"><colgroup><col /></colgroup><thead><tr><th class="catalog_table_entry"><p class="column_definition">
13        Column Type
14       </p>
15       <p>
16        Description
17       </p></th></tr></thead><tbody><tr><td class="catalog_table_entry"><p class="column_definition">
18        <code class="structfield">name</code> <code class="type">text</code>
19       </p>
20       <p>
21        The identifier of the prepared statement
22       </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
23        <code class="structfield">statement</code> <code class="type">text</code>
24       </p>
25       <p>
26        The query string submitted by the client to create this
27        prepared statement. For prepared statements created via SQL,
28        this is the <code class="command">PREPARE</code> statement submitted by
29        the client. For prepared statements created via the
30        frontend/backend protocol, this is the text of the prepared
31        statement itself.
32       </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
33        <code class="structfield">prepare_time</code> <code class="type">timestamptz</code>
34       </p>
35       <p>
36        The time at which the prepared statement was created
37       </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
38        <code class="structfield">parameter_types</code> <code class="type">regtype[]</code>
39       </p>
40       <p>
41        The expected parameter types for the prepared statement in the
42        form of an array of <code class="type">regtype</code>. The OID corresponding
43        to an element of this array can be obtained by casting the
44        <code class="type">regtype</code> value to <code class="type">oid</code>.
45       </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
46        <code class="structfield">result_types</code> <code class="type">regtype[]</code>
47       </p>
48       <p>
49        The types of the columns returned by the prepared statement in the
50        form of an array of <code class="type">regtype</code>. The OID corresponding
51        to an element of this array can be obtained by casting the
52        <code class="type">regtype</code> value to <code class="type">oid</code>.
53        If the prepared statement does not provide a result (e.g., a DML
54        statement), then this field will be null.
55       </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
56        <code class="structfield">from_sql</code> <code class="type">bool</code>
57       </p>
58       <p>
59        <code class="literal">true</code> if the prepared statement was created
60        via the <code class="command">PREPARE</code> SQL command;
61        <code class="literal">false</code> if the statement was prepared via the
62        frontend/backend protocol
63       </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
64        <code class="structfield">generic_plans</code> <code class="type">int8</code>
65       </p>
66       <p>
67        Number of times generic plan was chosen
68       </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
69        <code class="structfield">custom_plans</code> <code class="type">int8</code>
70       </p>
71       <p>
72        Number of times custom plan was chosen
73       </p></td></tr></tbody></table></div></div><br class="table-break" /><p>
74    The <code class="structname">pg_prepared_statements</code> view is read-only.
75   </p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="view-pg-policies.html" title="53.15. pg_policies">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="views.html" title="Chapter 53. System Views">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="view-pg-prepared-xacts.html" title="53.17. pg_prepared_xacts">Next</a></td></tr><tr><td width="40%" align="left" valign="top">53.15. <code class="structname">pg_policies</code> </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 18.0 Documentation">Home</a></td><td width="40%" align="right" valign="top"> 53.17. <code class="structname">pg_prepared_xacts</code></td></tr></table></div></body></html>