ALTER PROCEDURE

Description

Modifies the attributes of a user-defined stored procedure or recompiles a stored procedure.

Precautions

Only the owner of a stored procedure or a user granted with the ALTER permission can run the ALTER PROCEDURE command. The system administrator has this permission by default. The following are permission constraints depending on the attributes to be modified:
- If a stored procedure involves operations on temporary tables, ALTER PROCEDURE cannot be used.
- To modify the owner or schema of a stored procedure, you must be the owner of the stored procedure or system administrator and a member of the new owner role.
- Only the system administrator and initial user can change the schema of a stored procedure to a public schema.

The plpgsql_dependency parameter must be set for stored procedure compilation.

Syntax

Modify the additional parameters of a user-defined stored procedure.

ALTER PROCEDURE procedure_name ( [ { [ argname ] [ argmode ] argtype} [, ...] ] )
    action [ ... ] [ RESTRICT ];

The syntax of the ACTION clause is as follows:

{CALLED ON NULL INPUT  | STRICT}
 | {IMMUTABLE | STABLE | VOLATILE}
 | {SHIPPABLE | NOT SHIPPABLE}
 | {NOT FENCED | FENCED}
 | [ NOT ] LEAKPROOF
 | { [ EXTERNAL ] SECURITY INVOKER | [ EXTERNAL ] SECURITY DEFINER }
 | AUTHID { DEFINER | CURRENT_USER }
 | COST execution_cost
 | ROWS result_rows
 | SET configuration_parameter { { TO | = } { value | DEFAULT }| FROM CURRENT}
 | RESET {configuration_parameter | ALL}

Modify the name of a user-defined stored procedure.

ALTER PROCEDURE proname ( [ { [ argname ] [ argmode ] argtype} [, ...] ] )
    RENAME TO new_name;

Modify the owner of a user-defined stored procedure.

ALTER PROCEDURE proname ( [ { [ argname ] [ argmode ] argtype} [, ...] ] )
    OWNER TO new_owner;

Modify the schema of a user-defined stored procedure.

ALTER PROCEDURE proname ( [ { [ argname ] [ argmode ] argtype} [, ...] ] )
    SET SCHEMA new_schema;

Recompile a stored procedure.
```
ALTER PROCEDURE procedure_name COMPILE;
```

Parameters

procedure_name
Specifies the name of the stored procedure to be modified.

Value range: an existing stored procedure name
argmode
Specifies whether a parameter is an input or output parameter.

Value range: IN, OUT, INOUT, and VARIADIC
argname
Specifies the parameter name.

Value range: a string. It must comply with the naming convention.
argtype
Specifies the type of the stored procedure parameter.
CALLED ON NULL INPUT
Declares that some parameters of the stored procedure can be called in normal mode if the parameter values are null. Omitting this parameter is the same as specifying it.
IMMUTABLE
Specifies that the stored procedure always returns the same result if the parameter values are the same.
STABLE
Specifies that the stored procedure cannot modify the database, and that within a single table scan it will consistently return the same result for the same parameter value, but its result varies by SQL statements.
VOLATILE
Specifies that the stored procedure value can change in a single table scan and no optimization is performed.
LEAKPROOF
Specifies that the stored procedure has no side effect and the parameter contains only the return value. LEAKPROOF can be set only by the system administrator.
EXTERNAL
(Optional) The purpose is to be compatible with SQL. This feature applies to all functions, not only external functions.
SECURITY INVOKER
AUTHID CURRENT_USER

Specifies that the stored procedure will be executed with the permissions of the user who calls it. Omitting this parameter is the same as specifying it.

SECURITY INVOKER and AUTHID CURRENT_USER have the same functions.
SECURITY DEFINER
AUTHID DEFINER

Specifies that the stored procedure will be executed with the permissions of the user who created it.

AUTHID DEFINER and SECURITY DEFINER have the same functions.
COST execution_cost
Estimates the execution cost of the stored procedure.

The unit of execution_cost is cpu_operator_cost.

Value range: a positive integer
ROWS result_rows
Estimates the number of rows returned by the stored procedure. This is only allowed when the stored procedure is declared to return a set.

Value range: a positive number. The default value is 1000.
configuration_parameter
- value
  Sets a specified database session parameter to a specified value. If the value is DEFAULT or RESET, the default setting is used in the new session. OFF disables the setting.
  
  Value range: a string.
  - DEFAULT
  - OFF
  - RESET
  Specifies the default value.
- from current
  Uses the value of configuration_parameter of the current session.
new_name
Specifies the new name of the stored procedure. To change the schema of a stored procedure, you must have the CREATE permission on the new schema.

Value range: a string. It must comply with the naming convention.
new_owner
Specifies the new owner of the stored procedure. To change the owner of a stored procedure, the new owner must have the CREATE permission on the schema to which the stored procedure belongs.

Value range: an existing user role
new_schema
Specifies the new schema of the stored procedure.

Value range: an existing schema

Examples

See Examples in section "CREATE FUNCTION."

Recompilation examples:

-- Enable the dependency function.
gaussdb=# set behavior_compat_options ='plpgsql_dependency';
-- Create a stored procedure.
gaussdb=# create or replace procedure test_proc(a int)
is
    proc_var int;
begin
    proc_var := a;
end;
/
-- Recompile a stored procedure with the stored procedure name.
gaussdb=# alter procedure test_proc compile;

-- Recompile a stored procedure with a signed int type stored procedure.
gaussdb=# alter procedure test_proc(int) compile;