codekingpro/portable-devtools

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>DROP PROCEDURE</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="sql-droppolicy.html" title="DROP POLICY" /><link rel="next" href="sql-droppublication.html" title="DROP PUBLICATION" /></head><body id="docContent" class="container-fluid col-10"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">DROP PROCEDURE</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="sql-droppolicy.html" title="DROP POLICY">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="sql-commands.html" title="SQL Commands">Up</a></td><th width="60%" align="center">SQL Commands</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 16.3 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="sql-droppublication.html" title="DROP PUBLICATION">Next</a></td></tr></table><hr /></div><div class="refentry" id="SQL-DROPPROCEDURE"><div class="titlepage"></div><a id="id-1.9.3.124.1" class="indexterm"></a><div class="refnamediv"><h2><span class="refentrytitle">DROP PROCEDURE</span></h2><p>DROP PROCEDURE — remove a procedure</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">3DROP PROCEDURE [ IF EXISTS ] <em class="replaceable"><code>name</code></em> [ ( [ [ <em class="replaceable"><code>argmode</code></em> ] [ <em class="replaceable"><code>argname</code></em> ] <em class="replaceable"><code>argtype</code></em> [, ...] ] ) ] [, ...]4    [ CASCADE | RESTRICT ]5</pre></div><div class="refsect1" id="id-1.9.3.124.5"><h2>Description</h2><p>6   <code class="command">DROP PROCEDURE</code> removes the definition of one or more7   existing procedures. To execute this command the user must be the8   owner of the procedure(s). The argument types to the9   procedure(s) usually must be specified, since several different procedures10   can exist with the same name and different argument lists.11  </p></div><div class="refsect1" id="id-1.9.3.124.6"><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="literal">IF EXISTS</code></span></dt><dd><p>12      Do not throw an error if the procedure does not exist. A notice is issued13      in this case.14     </p></dd><dt><span class="term"><em class="replaceable"><code>name</code></em></span></dt><dd><p>15      The name (optionally schema-qualified) of an existing procedure.16     </p></dd><dt><span class="term"><em class="replaceable"><code>argmode</code></em></span></dt><dd><p>17      The mode of an argument: <code class="literal">IN</code>, <code class="literal">OUT</code>,18      <code class="literal">INOUT</code>, or <code class="literal">VARIADIC</code>.  If omitted,19      the default is <code class="literal">IN</code> (but see below).20     </p></dd><dt><span class="term"><em class="replaceable"><code>argname</code></em></span></dt><dd><p>21      The name of an argument.22      Note that <code class="command">DROP PROCEDURE</code> does not actually pay23      any attention to argument names, since only the argument data24      types are used to determine the procedure's identity.25     </p></dd><dt><span class="term"><em class="replaceable"><code>argtype</code></em></span></dt><dd><p>26      The data type(s) of the procedure's arguments (optionally27      schema-qualified), if any.28      See below for details.29     </p></dd><dt><span class="term"><code class="literal">CASCADE</code></span></dt><dd><p>30      Automatically drop objects that depend on the procedure,31      and in turn all objects that depend on those objects32      (see <a class="xref" href="ddl-depend.html" title="5.14. Dependency Tracking">Section 5.14</a>).33     </p></dd><dt><span class="term"><code class="literal">RESTRICT</code></span></dt><dd><p>34      Refuse to drop the procedure if any objects depend on it.  This35      is the default.36     </p></dd></dl></div></div><div class="refsect1" id="SQL-DROPPROCEDURE-NOTES"><h2>Notes</h2><p>37   If there is only one procedure of the given name, the argument list38   can be omitted.  Omit the parentheses too in this case.39  </p><p>40   In <span class="productname">PostgreSQL</span>, it's sufficient to list the41   input (including <code class="literal">INOUT</code>) arguments,42   because no two routines of the same name are allowed to share the same43   input-argument list.  Moreover, the <code class="command">DROP</code> command44   will not actually check that you wrote the types45   of <code class="literal">OUT</code> arguments correctly; so any arguments that46   are explicitly marked <code class="literal">OUT</code> are just noise.  But47   writing them is recommendable for consistency with the48   corresponding <code class="command">CREATE</code> command.49  </p><p>50   For compatibility with the SQL standard, it is also allowed to write51   all the argument data types (including those of <code class="literal">OUT</code>52   arguments) without53   any <em class="replaceable"><code>argmode</code></em> markers.54   When this is done, the types of the procedure's <code class="literal">OUT</code>55   argument(s) <span class="emphasis"><em>will</em></span> be verified against the command.56   This provision creates an ambiguity, in that when the argument list57   contains no <em class="replaceable"><code>argmode</code></em>58   markers, it's unclear which rule is intended.59   The <code class="command">DROP</code> command will attempt the lookup both ways,60   and will throw an error if two different procedures are found.61   To avoid the risk of such ambiguity, it's recommendable to62   write <code class="literal">IN</code> markers explicitly rather than letting them63   be defaulted, thus forcing the64   traditional <span class="productname">PostgreSQL</span> interpretation to be65   used.66  </p><p>67   The lookup rules just explained are also used by other commands that68   act on existing procedures, such as <code class="command">ALTER PROCEDURE</code>69   and <code class="command">COMMENT ON PROCEDURE</code>.70  </p></div><div class="refsect1" id="SQL-DROPPROCEDURE-EXAMPLES"><h2>Examples</h2><p>71   If there is only one procedure <code class="literal">do_db_maintenance</code>,72   this command is sufficient to drop it:73</p><pre class="programlisting">74DROP PROCEDURE do_db_maintenance;75</pre><p>76  </p><p>77   Given this procedure definition:78</p><pre class="programlisting">79CREATE PROCEDURE do_db_maintenance(IN target_schema text, OUT results text) ...80</pre><p>81   any one of these commands would work to drop it:82</p><pre class="programlisting">83DROP PROCEDURE do_db_maintenance(IN target_schema text, OUT results text);84DROP PROCEDURE do_db_maintenance(IN text, OUT text);85DROP PROCEDURE do_db_maintenance(IN text);86DROP PROCEDURE do_db_maintenance(text);87DROP PROCEDURE do_db_maintenance(text, text);  -- potentially ambiguous88</pre><p>89   However, the last example would be ambiguous if there is also, say,90</p><pre class="programlisting">91CREATE PROCEDURE do_db_maintenance(IN target_schema text, IN options text) ...92</pre></div><div class="refsect1" id="SQL-DROPPROCEDURE-COMPATIBILITY"><h2>Compatibility</h2><p>93   This command conforms to the SQL standard, with94   these <span class="productname">PostgreSQL</span> extensions:95   </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>The standard only allows one procedure to be dropped per command.</p></li><li class="listitem"><p>The <code class="literal">IF EXISTS</code> option is an extension.</p></li><li class="listitem"><p>The ability to specify argument modes and names is an96     extension, and the lookup rules differ when modes are given.</p></li></ul></div></div><div class="refsect1" id="id-1.9.3.124.10"><h2>See Also</h2><span class="simplelist"><a class="xref" href="sql-createprocedure.html" title="CREATE PROCEDURE"><span class="refentrytitle">CREATE PROCEDURE</span></a>, <a class="xref" href="sql-alterprocedure.html" title="ALTER PROCEDURE"><span class="refentrytitle">ALTER PROCEDURE</span></a>, <a class="xref" href="sql-dropfunction.html" title="DROP FUNCTION"><span class="refentrytitle">DROP FUNCTION</span></a>, <a class="xref" href="sql-droproutine.html" title="DROP ROUTINE"><span class="refentrytitle">DROP ROUTINE</span></a></span></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="sql-droppolicy.html" title="DROP POLICY">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="sql-commands.html" title="SQL Commands">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="sql-droppublication.html" title="DROP PUBLICATION">Next</a></td></tr><tr><td width="40%" align="left" valign="top">DROP POLICY </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 16.3 Documentation">Home</a></td><td width="40%" align="right" valign="top"> DROP PUBLICATION</td></tr></table></div></body></html>