begriffs open source - ai-pg/blob - full-docs/src/sgml/html/pltcl-config.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>42.11. PL/Tcl Configuration</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="pltcl-transactions.html" title="42.10. Transaction Management" /><link rel="next" href="pltcl-procnames.html" title="42.12. Tcl Procedure Names" /></head><body id="docContent" class="container-fluid col-10"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">42.11. PL/Tcl Configuration</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="pltcl-transactions.html" title="42.10. Transaction Management">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="pltcl.html" title="Chapter 42. PL/Tcl — Tcl Procedural Language">Up</a></td><th width="60%" align="center">Chapter 42. PL/Tcl — Tcl Procedural Language</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="pltcl-procnames.html" title="42.12. Tcl Procedure Names">Next</a></td></tr></table><hr /></div><div class="sect1" id="PLTCL-CONFIG"><div class="titlepage"><div><div><h2 class="title" style="clear: both">42.11. PL/Tcl Configuration <a href="#PLTCL-CONFIG" class="id_link">#</a></h2></div></div></div><p>
   3      This section lists configuration parameters that
   4      affect <span class="application">PL/Tcl</span>.
   5     </p><div class="variablelist"><dl class="variablelist"><dt id="GUC-PLTCL-START-PROC"><span class="term">
   6        <code class="varname">pltcl.start_proc</code> (<code class="type">string</code>)
   7        <a id="id-1.8.9.15.3.1.1.3" class="indexterm"></a>
   8       </span> <a href="#GUC-PLTCL-START-PROC" class="id_link">#</a></dt><dd><p>
   9         This parameter, if set to a nonempty string, specifies the name
  10         (possibly schema-qualified) of a parameterless PL/Tcl function that
  11         is to be executed whenever a new Tcl interpreter is created for
  12         PL/Tcl.  Such a function can perform per-session initialization, such
  13         as loading additional Tcl code.  A new Tcl interpreter is created
  14         when a PL/Tcl function is first executed in a database session, or
  15         when an additional interpreter has to be created because a PL/Tcl
  16         function is called by a new SQL role.
  17        </p><p>
  18         The referenced function must be written in the <code class="literal">pltcl</code>
  19         language, and must not be marked <code class="literal">SECURITY DEFINER</code>.
  20         (These restrictions ensure that it runs in the interpreter it's
  21         supposed to initialize.)  The current user must have permission to
  22         call it, too.
  23        </p><p>
  24         If the function fails with an error it will abort the function call
  25         that caused the new interpreter to be created and propagate out to
  26         the calling query, causing the current transaction or subtransaction
  27         to be aborted.  Any actions already done within Tcl won't be undone;
  28         however, that interpreter won't be used again.  If the language is
  29         used again the initialization will be attempted again within a fresh
  30         Tcl interpreter.
  31        </p><p>
  32         Only superusers can change this setting.  Although this setting
  33         can be changed within a session, such changes will not affect Tcl
  34         interpreters that have already been created.
  35        </p></dd><dt id="GUC-PLTCLU-START-PROC"><span class="term">
  36        <code class="varname">pltclu.start_proc</code> (<code class="type">string</code>)
  37        <a id="id-1.8.9.15.3.2.1.3" class="indexterm"></a>
  38       </span> <a href="#GUC-PLTCLU-START-PROC" class="id_link">#</a></dt><dd><p>
  39         This parameter is exactly like <code class="varname">pltcl.start_proc</code>,
  40         except that it applies to PL/TclU.  The referenced function must
  41         be written in the <code class="literal">pltclu</code> language.
  42        </p></dd></dl></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="pltcl-transactions.html" title="42.10. Transaction Management">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="pltcl.html" title="Chapter 42. PL/Tcl — Tcl Procedural Language">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="pltcl-procnames.html" title="42.12. Tcl Procedure Names">Next</a></td></tr><tr><td width="40%" align="left" valign="top">42.10. Transaction Management </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"> 42.12. Tcl Procedure Names</td></tr></table></div></body></html>