Movatterモバイル変換

ALTER PROCEDURE
Prev	Up	SQL Commands	Home	Next

ALTER PROCEDURE

ALTER PROCEDURE — change the definition of a procedure

Synopsis

ALTER PROCEDUREname [ ( [ [argmode ] [argname ]argtype [, ...] ] ) ]action [ ... ] [ RESTRICT ]ALTER PROCEDUREname [ ( [ [argmode ] [argname ]argtype [, ...] ] ) ]    RENAME TOnew_nameALTER PROCEDUREname [ ( [ [argmode ] [argname ]argtype [, ...] ] ) ]    OWNER TO {new_owner | CURRENT_ROLE | CURRENT_USER | SESSION_USER }ALTER PROCEDUREname [ ( [ [argmode ] [argname ]argtype [, ...] ] ) ]    SET SCHEMAnew_schemaALTER PROCEDUREname [ ( [ [argmode ] [argname ]argtype [, ...] ] ) ]    [ NO ] DEPENDS ON EXTENSIONextension_namewhereaction is one of:    [ EXTERNAL ] SECURITY INVOKER | [ EXTERNAL ] SECURITY DEFINER    SETconfiguration_parameter { TO | = } {value | DEFAULT }    SETconfiguration_parameter FROM CURRENT    RESETconfiguration_parameter    RESET ALL

Description

ALTER PROCEDURE changes the definition of a procedure.

You must own the procedure to useALTER PROCEDURE. To change a procedure's schema, you must also haveCREATE privilege on the new schema. To alter the owner, you must be able toSET ROLE to the new owning role, and that role must haveCREATE privilege on the procedure's schema. (These restrictions enforce that altering the owner doesn't do anything you couldn't do by dropping and recreating the procedure. However, a superuser can alter ownership of any procedure anyway.)

Parameters

name

The name (optionally schema-qualified) of an existing procedure. If no argument list is specified, the name must be unique in its schema.

argmode

The mode of an argument:IN,OUT,INOUT, orVARIADIC. If omitted, the default isIN.

argname

The name of an argument. Note thatALTER PROCEDURE does not actually pay any attention to argument names, since only the argument data types are used to determine the procedure's identity.

argtype

The data type(s) of the procedure's arguments (optionally schema-qualified), if any. SeeDROP PROCEDURE for the details of how the procedure is looked up using the argument data type(s).

new_name

The new name of the procedure.

new_owner

The new owner of the procedure. Note that if the procedure is markedSECURITY DEFINER, it will subsequently execute as the new owner.

new_schema

The new schema for the procedure.

extension_name

This form marks the procedure as dependent on the extension, or no longer dependent on the extension ifNO is specified. A procedure that's marked as dependent on an extension is dropped when the extension is dropped, even if cascade is not specified. A procedure can depend upon multiple extensions, and will be dropped when any one of those extensions is dropped.

[ EXTERNAL] SECURITY INVOKER [ EXTERNAL] SECURITY DEFINER

Change whether the procedure is a security definer or not. The key wordEXTERNAL is ignored for SQL conformance. SeeCREATE PROCEDURE for more information about this capability.

configuration_parameter value

Add or change the assignment to be made to a configuration parameter when the procedure is called. Ifvalue isDEFAULT or, equivalently,RESET is used, the procedure-local setting is removed, so that the procedure executes with the value present in its environment. UseRESET ALL to clear all procedure-local settings.SET FROM CURRENT saves the value of the parameter that is current whenALTER PROCEDURE is executed as the value to be applied when the procedure is entered.

SeeSET andChapter 18 for more information about allowed parameter names and values.

RESTRICT

Ignored for conformance with the SQL standard.

Examples

To rename the procedureinsert_data with two arguments of typeinteger toinsert_record:

ALTER PROCEDURE insert_data(integer, integer) RENAME TO insert_record;

To change the owner of the procedureinsert_data with two arguments of typeinteger tojoe:

ALTER PROCEDURE insert_data(integer, integer) OWNER TO joe;

To change the schema of the procedureinsert_data with two arguments of typeinteger toaccounting:

ALTER PROCEDURE insert_data(integer, integer) SET SCHEMA accounting;

To mark the procedureinsert_data(integer, integer) as being dependent on the extensionmyext:

ALTER PROCEDURE insert_data(integer, integer) DEPENDS ON EXTENSION myext;

To adjust the search path that is automatically set for a procedure:

ALTER PROCEDURE check_password(text) SET search_path = admin, pg_temp;

To disable automatic setting ofsearch_path for a procedure:

ALTER PROCEDURE check_password(text) RESET search_path;

The procedure will now execute with whatever search path is used by its caller.

Compatibility

This statement is partially compatible with theALTER PROCEDURE statement in the SQL standard. The standard allows more properties of a procedure to be modified, but does not provide the ability to rename a procedure, make a procedure a security definer, attach configuration parameter values to a procedure, or change the owner, schema, or volatility of a procedure. The standard also requires theRESTRICT key word, which is optional inPostgres Pro.