Wiki / psql Commands / Describe database objects

\df

Reading PostgreSQL 18.6.

Description

Lists functions, together with their result data types, argument data types, and function types, which are classified as “ agg ” (aggregate), “ normal ” , “ procedure ” , “ trigger ” , or “ window ” . To display only functions of specific type(s), add the corresponding letters a , n , p , t , or w to the command. If pattern is specified, only functions whose names match the pattern are shown. Any additional arguments are type-name patterns, which are matched to the type names of the first, second, and so on arguments of the function. (Matching functions can have more arguments than what you specify. To prevent that, write a dash - as the last arg_pattern .) By default, only user-created objects are shown; supply a pattern or the S modifier to include system objects. If x is appended to the command name, the results are displayed in expanded mode. If + is appended to the command name, additional information about each function is shown, including volatility, parallel safety, owner, security classification, whether it is leakproof, access privileges, language, internal name (for C and internal functions only), and description. Source code for a specific function can be seen using \sf .

Client: psql 18.6
Case-sensitive spelling: \df

Usage

\df[anptwSx+] [ pattern [ arg_pattern ... ] ]

Spellings in this manual definition

Command	Documented suffix modifiers
\df	anptwSx+

Manual definition

\df[anptwSx+] [ pattern [ arg_pattern ... ] ]: Lists functions, together with their result data types, argument data types, and function types, which are classified as “agg” (aggregate), “normal”, “procedure”, “trigger”, or “window”. To display only functions of specific type(s), add the corresponding letters a, n, p, t, or w to the command. If pattern is specified, only functions whose names match the pattern are shown. Any additional arguments are type-name patterns, which are matched to the type names of the first, second, and so on arguments of the function. (Matching functions can have more arguments than what you specify. To prevent that, write a dash - as the last arg_pattern.) By default, only user-created objects are shown; supply a pattern or the S modifier to include system objects. If x is appended to the command name, the results are displayed in expanded mode. If + is appended to the command name, additional information about each function is shown, including volatility, parallel safety, owner, security classification, whether it is leakproof, access privileges, language, internal name (for C and internal functions only), and description. Source code for a specific function can be seen using \sf.

Related entries

psql command-line options and complete manual

Documentation and source

18.6 English manual · app-psql.html

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 17 → 18: changed.

--- PostgreSQL 17
+++ PostgreSQL 18
@@ -1,12 +1,12 @@
 {
-  "definition": "Lists functions, together with their result data types, argument data types, and function types, which are classified as “ agg ” (aggregate), “ normal ” , “ procedure ” , “ trigger ” , or “ window ” . To display only functions of specific type(s), add the corresponding letters a , n , p , t , or w to the command. If pattern is specified, only functions whose names match the pattern are shown. Any additional arguments are type-name patterns, which are matched to the type names of the first, second, and so on arguments of the function. (Matching functions can have more arguments than what you specify. To prevent that, write a dash - as the last arg_pattern .) By default, only user-created objects are shown; supply a pattern or the S modifier to include system objects. If the form \\df+ is used, additional information about each function is shown, including volatility, parallel safety, owner, security classification, access privileges, language, internal name (for C and internal functions only), and description. Source code for a specific function can be seen using \\sf .",
+  "definition": "Lists functions, together with their result data types, argument data types, and function types, which are classified as “ agg ” (aggregate), “ normal ” , “ procedure ” , “ trigger ” , or “ window ” . To display only functions of specific type(s), add the corresponding letters a , n , p , t , or w to the command. If pattern is specified, only functions whose names match the pattern are shown. Any additional arguments are type-name patterns, which are matched to the type names of the first, second, and so on arguments of the function. (Matching functions can have more arguments than what you specify. To prevent that, write a dash - as the last arg_pattern .) By default, only user-created objects are shown; supply a pattern or the S modifier to include system objects. If x is appended to the command name, the results are displayed in expanded mode. If + is appended to the command name, additional information about each function is shown, including volatility, parallel safety, owner, security classification, whether it is leakproof, access privileges, language, internal name (for C and internal functions only), and description. Source code for a specific function can be seen using \\sf .",
   "modifiers": [
     {
       "command": "\\df",
-      "modifiers": "anptwS+"
+      "modifiers": "anptwSx+"
     }
   ],
-  "signature": "\\df[anptwS+] [ pattern [ arg_pattern ... ] ]",
+  "signature": "\\df[anptwSx+] [ pattern [ arg_pattern ... ] ]",
   "spellings": [
     "\\df"
   ]

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.