ALTER PROCEDURE

Synopsis

Use the ALTER PROCEDURE statement to change properties of an existing procedure.

Syntax

• Grammar
• Diagram

alter_procedure ::= ALTER PROCEDURE subprogram_name ( 
                    [ subprogram_signature ] )  
                    { special_fn_and_proc_attribute
                      | alterable_fn_and_proc_attribute [ ... ] 
                        [ RESTRICT ] }

subprogram_signature ::= arg_decl [ , ... ]

arg_decl ::= [ formal_arg ] [ arg_mode ] arg_type

special_fn_and_proc_attribute ::= RENAME TO subprogram_name
                                  | OWNER TO 
                                    { role_name
                                      | CURRENT_ROLE
                                      | CURRENT_USER
                                      | SESSION_USER }
                                  | SET SCHEMA schema_name
                                  | [ NO ] DEPENDS ON EXTENSION 
                                    extension_name

alterable_fn_and_proc_attribute ::= SET run_time_parameter 
                                    { TO value
                                      | = value
                                      | FROM CURRENT }
                                    | RESET run_time_parameter
                                    | RESET ALL
                                    | [ EXTERNAL ] SECURITY 
                                      { INVOKER | DEFINER }

You must identify the to-be-altered procedure by:

• Its name and the schema where it lives. This can be done by using its fully qualified name or by using just its bare name and letting name resolution find it in the first schema on the search_path where it occurs. Notice that you don't need to (and cannot) mention the name of its owner.

• Its signature. The subprogram_call_signature is sufficient; and this is typically used. You can use the full subprogram_signature. But you should realize that the formal_arg and arg_mode for each arg_decl carry no identifying information. (This is why it is not typically used when a function or procedure is to be altered or dropped.) This is explained in the section Subprogram overloading.

Semantics

This is explained in the section Subprogram attributes.

Example

Supposed that you create a procedure like this:

drop schema if exists s1 cascade;
drop schema if exists s2 cascade;
create schema s1;

create procedure s1.p(i in int)
  security definer
  language plpgsql
as $body$
begin
  execute format('set my_namespace.x = %L', i::text);
end;
$body$;

call s1.p(42);
select current_setting('my_namespace.x')::int as "my_namespace.x";

This is the result:

 my_namespace.x
----------------
             42

Now suppose you want to change the security attribute, set a configuration parameter, rename the procedure, and move it to a different schema. You must use separate ALTER statements for each change:

alter procedure s1.p(int) security invoker;
alter procedure s1.p(int) set statement_timeout = '1s';
alter procedure s1.p(int) rename to q;

Create a schema to move the procedure to:

create schema s2;
alter procedure s1.q(int) set schema s2;

You can verify the changes by querying the procedure's metadata. See the section The "pg_proc" catalog table for subprograms for information on how to query subprogram metadata:

select
  proname::text                     as name,
  pronamespace::regnamespace::text  as schema,
  case
    when prosecdef then 'definer'
    else 'invoker'
  end                               as security,
  proconfig                         as settings
from pg_proc
where
  proname::text in ('p', 'q')
order by proname;

This shows the updated procedure:

 name | schema | security |       settings
------+--------+----------+-----------------------
 q    | s2     | invoker  | {statement_timeout=1s}

Mark extension dependencies

Use DEPENDS ON EXTENSION to mark a procedure as dependent on an extension:

CREATE EXTENSION "uuid-ossp";

-- Mark the procedure as dependent on the extension
ALTER PROCEDURE s2.q(int) DEPENDS ON EXTENSION "uuid-ossp";

-- Remove the dependency mark if needed
ALTER PROCEDURE s2.q(int) NO DEPENDS ON EXTENSION "uuid-ossp";

When an extension is dropped, all dependent objects are dropped or updated accordingly.

See also

• ALTER ROUTINE
• CREATE PROCEDURE
• DROP PROCEDURE
• CREATE FUNCTION
• ALTER FUNCTION
• DROP FUNCTION