Wiki / psql Commands / Query buffer and editing
\ef
This command fetches and edits the definition of the named function or procedure, in the form of a CREATE OR REPLACE FUNCTION or CREATE OR REPLACE PROCEDURE command. Editing is done in the same way as for \edit . If you quit the editor without savin…
Reading PostgreSQL 18.6.
Description
This command fetches and edits the definition of the named function or procedure, in the form of a CREATE OR REPLACE FUNCTION or CREATE OR REPLACE PROCEDURE command. Editing is done in the same way as for \edit . If you quit the editor without saving, the statement is discarded. If you save and exit the editor, the updated command is executed immediately if you added a semicolon to it. Otherwise it is redisplayed; type semicolon or \g to send it, or \r to cancel.
- Client
- psql 18.6
- Case-sensitive spelling
- \ef
Usage
\ef [ function_description [ line_number ] ]Spellings in this manual definition
| Command | Documented suffix modifiers |
|---|---|
| \ef | None listed in this signature |
Manual definition
\ef [function_description[line_number] ]-
This command fetches and edits the definition of the named function or procedure, in the form of a
CREATE OR REPLACE FUNCTIONorCREATE OR REPLACE PROCEDUREcommand. Editing is done in the same way as for\edit. If you quit the editor without saving, the statement is discarded. If you save and exit the editor, the updated command is executed immediately if you added a semicolon to it. Otherwise it is redisplayed; type semicolon or\gto send it, or\rto cancel.The target function can be specified by name alone, or by name and arguments, for example
foo(integer, text). The argument types must be given if there is more than one function of the same name.If no function is specified, a blank
CREATE FUNCTIONtemplate is presented for editing.If a line number is specified, psql will position the cursor on the specified line of the function body. (Note that the function body typically does not begin on the first line of the file.)
Unlike most other meta-commands, the entire remainder of the line is always taken to be the argument(s) of
\ef, and neither variable interpolation nor backquote expansion are performed in the arguments.Tip
See Environment, below, for how to configure and customize your editor.
Related entries
Documentation and source
Source build
- Version
- 18.6
- Build
- https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2
- Source fingerprint
ee8d1a3612338fd9adf250730cb640fcc5233b5491337cc00a316a44e3a0b9f8
Compare versions
PostgreSQL 12 → 13: changed.
--- PostgreSQL 12
+++ PostgreSQL 13
@@ -1,5 +1,5 @@
{
- "definition": "This command fetches and edits the definition of the named function or procedure, in the form of a CREATE OR REPLACE FUNCTION or CREATE OR REPLACE PROCEDURE command. Editing is done in the same way as for \\edit . After the editor exits, the updated command waits in the query buffer; type semicolon or \\g to send it, or \\r to cancel. The target function can be specified by name alone, or by name and arguments, for example foo(integer, text) . The argument types must be given if there is more than one function of the same name. If no function is specified, a blank CREATE FUNCTION template is presented for editing. If a line number is specified, psql will position the cursor on the specified line of the function body. (Note that the function body typically does not begin on the first line of the file.) Unlike most other meta-commands, the entire remainder of the line is always taken to be the argument(s) of \\ef , and neither variable interpolation nor backquote expansion are performed in the arguments. Tip See under Environment for how to configure and customize your editor.",
+ "definition": "This command fetches and edits the definition of the named function or procedure, in the form of a CREATE OR REPLACE FUNCTION or CREATE OR REPLACE PROCEDURE command. Editing is done in the same way as for \\edit . After the editor exits, the updated command is executed immediately if you added a semicolon to it. Otherwise it is redisplayed; type semicolon or \\g to send it, or \\r to cancel. The target function can be specified by name alone, or by name and arguments, for example foo(integer, text) . The argument types must be given if there is more than one function of the same name. If no function is specified, a blank CREATE FUNCTION template is presented for editing. If a line number is specified, psql will position the cursor on the specified line of the function body. (Note that the function body typically does not begin on the first line of the file.) Unlike most other meta-commands, the entire remainder of the line is always taken to be the argument(s) of \\ef , and neither variable interpolation nor backquote expansion are performed in the arguments. Tip See Environment , below, for how to configure and customize your editor.",
"modifiers": [],
"signature": "\\ef [ function_description [ line_number ] ]",
"spellings": [Compares recorded interfaces and attributes. Source fingerprints and build metadata are excluded; an absent sample is not proof of the introduction or removal release.
Related entries
Export JSON · Back to psql Commands · Recorded in PostgreSQL 10 through 20; the first sample is not necessarily its introduction.