ALTER_PROCEDURE(7pg13)

πŸ“¦ version 13.23, in opensuse-leap 16.0

✨ ALTER PROCEDURE ✨

okay so bestie, let me tell you about ALTER PROCEDURE β€” this is from the PostgreSQL 13.23 Documentation, and it's literally the glow-up command for your stored procedures. πŸ’…


πŸ’– NAME πŸ’–

ALTER_PROCEDURE β€” like, changing the definition of a procedure. No cap. πŸŽ€


🌸 SYNOPSIS 🌸

ALTER PROCEDURE name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ]
    action [ ... ] [ RESTRICT ]
ALTER PROCEDURE name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ]
    RENAME TO new_name
ALTER PROCEDURE name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ]
    OWNER TO { new_owner | CURRENT_USER | SESSION_USER }
ALTER PROCEDURE name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ]
    SET SCHEMA new_schema
ALTER PROCEDURE name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ]
    [ NO ] DEPENDS ON EXTENSION extension_name

where action is one of:

    [ EXTERNAL ] SECURITY INVOKER | [ EXTERNAL ] SECURITY DEFINER
    SET configuration_parameter { TO | = } { value | DEFAULT }
    SET configuration_parameter FROM CURRENT
    RESET configuration_parameter
    RESET ALL

πŸ¦‹ DESCRIPTION πŸ¦‹

ALTER PROCEDURE literally changes the definition of a procedure. It's giving main character energy. ✨

But like, there are rules, bestie. You must own the procedure to use ALTER PROCEDURE. To change a procedure's schema, you also need CREATE privilege on the new schema. And to alter the owner, you have to be a direct or indirect member of the new owning role, and that role must have CREATE 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. πŸ‘‘)

lowkey important: don't skip the ownership rules or you'll get a vibe check from the database. πŸ™ˆ

πŸ’œ 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. Like, you gotta be specific, bestie. 🎯
  • argmode β€” The mode of an argument: IN or VARIADIC. If omitted, the default is IN. Slay. πŸ’…
  • argname β€” The name of an argument. Note that ALTER PROCEDURE does not actually pay any attention to argument names, since only the argument data types are needed to determine the procedure's identity. So like, names are cute but not relevant here. πŸ™ˆ
  • argtype β€” The data type(s) of the procedure's arguments (optionally schema-qualified), if any. This is the important part, fr fr. πŸ”₯
  • new_name β€” The new name of the procedure. Glow-up name change, periodt. ✨
  • new_owner β€” The new owner of the procedure. Note that if the procedure is marked SECURITY DEFINER, it will subsequently execute as the new owner. So like, be careful who you give the keys to. πŸ”‘
  • new_schema β€” The new schema for the procedure. Moving it to a new neighborhood. 🏑
  • extension_name β€” This form marks the procedure as dependent on the extension, or no longer dependent on the extension if NO 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. So like, it's a package deal. πŸ’€
  • [ EXTERNAL ] SECURITY INVOKER / [ EXTERNAL ] SECURITY DEFINER β€” Change whether the procedure is a security definer or not. The key word EXTERNAL is ignored for SQL conformance. See CREATE PROCEDURE (CREATE_PROCEDURE(7)) for more information about this capability. Basically, security definer is like main character energy for permissions. πŸ‘‘
  • configuration_parameter / value β€” Add or change the assignment to be made to a configuration parameter when the procedure is called. If value is DEFAULT or, equivalently, RESET is used, the procedure-local setting is removed, so that the procedure executes with the value present in its environment. Use RESET ALL to clear all procedure-local settings. SET FROM CURRENT saves the value of the parameter that is current when ALTER PROCEDURE is executed as the value to be applied when the procedure is entered. See SET(7) and Chapter 19 for more information about allowed parameter names and values. It's like setting a vibe for when the procedure runs. 🌈
  • RESTRICT β€” Ignored for conformance with the SQL standard. Literally does nothing, bestie. πŸ’€

πŸŽ€ EXAMPLES πŸŽ€

Okay so here's how you actually do stuff, bestie. πŸ’…

To rename the procedure insert_data with two arguments of type integer to insert_record:

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

To change the owner of the procedure insert_data with two arguments of type integer to joe:

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

To change the schema of the procedure insert_data with two arguments of type integer to accounting:

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

To mark the procedure insert_data(integer, integer) as being dependent on the extension myext:

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 of search_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. So like, it inherits the vibe of whoever calls it. ✨


🌈 COMPATIBILITY 🌈

This statement is partially compatible with the ALTER 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 the RESTRICT key word, which is optional in PostgreSQL. So like, PostgreSQL is more chill about it. πŸ’…


πŸ”₯ SEE ALSO πŸ”₯


πŸ’– that's it bestie! this page was brought to you by PostgreSQL 13.23, 2025 edition. now go slay those procedures! πŸ’–

πŸ“¦ where this page comes from